Skip to content

Commit

Permalink
WIP: Progress in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanpeach committed Nov 1, 2024
1 parent f195701 commit 85b00aa
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ A linter whose goal is to lint wikilinks in a variety of markdown note taking ap
# Lint Rules

- [X] Similar Files: Two files share a very similar title. Maybe you should combine them?
- [ ] Broken Wikilink: Some wikilink's derived file path does not exist. Maybe you should create it, or maybe the link title is misspelled?
- [ ] Unlinked Text: Text was detected which is very similar to some file title or alias. Maybe you should wrap it as a link?
- [X] Duplicate Alias: If using something like [logseq aliases](https://unofficial-logseq-docs.gitbook.io/unofficial-logseq-docs/beginner-to-advance-features/aliases), make sure they are always unique.
- [X] Broken Wikilink: Some wikilink's derived resource does not exist. Maybe you should create it, or maybe the link title is misspelled?
- [ ] Misspelled File Name: Mispellings can make it hard for the linker to do its job.
- [ ] Misspelled Wikilink: Mispellings can make it hard for the linker to do its job.
- [ ] Misspelled Alias: Mispellings can make it hard for the linker to do its job.
- [ ] Unlinked Text: Text was detected which is very similar to some file title or alias. Maybe you should wrap it as a link?
- [ ] Missing "Related To":
- [ ] If one block contains 2 or more wikilinks, add each of them to each other's "Related To"
- [ ] If one block with a wikilink has a subblock with a wikilink, add each of them to each other's "Related To"
Expand Down

0 comments on commit 85b00aa

Please sign in to comment.