From c04dd2b435a362a9ad21fdcd618860f35acc062a Mon Sep 17 00:00:00 2001 From: Felix Zeller Date: Mon, 26 Feb 2024 18:41:14 -0500 Subject: [PATCH] fix: Readme prose and grammar --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1b4166bd..edd66945 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Markdown Oxide - -Implementing obsidian PKM features (and possibly more) in the form of a language server allows us to use these features in our favorite text editors and reuse other lsp related plugins (like Telescope, outline, refactoring tools, ...) +Implementing obsidian PKM features (and possibly more) in the form of a language server allows us to use these features in our favorite text editors and reuse other LSP-related plugins (like Telescope, outline, refactoring tools, ...). This primary plugin attempts to be a complete replacement and extension to the Obsidian markdown editor for Obsidian vault PKM-ing in your favorite text editing system. ## Installation @@ -82,13 +81,14 @@ vim.api.nvim_exec_autocmds('User', { pattern = 'LspAttached' }) ``` -1. Test it out! Go to definitions, get references, and more! +*Test it out! Go to definitions, get references, and more!* -NOTE: To get references on files, you must place your cursor/pointer on the first character of the first line of the file, and then get references. (In VSCode, you can also use the references code lens) +> [!NOTE] +> To get references on files, you must place your cursor/pointer on the first character of the first line of the file, and then get references. (In VSCode, you can also use the references code lens) ## Note on Linking Syntax -The linking syntax is that of obsidian's and can be found here https://help.obsidian.md/Linking+notes+and+files/Internal+links +The linking syntax is that of Obsidian's and can be found here https://help.obsidian.md/Linking+notes+and+files/Internal+links Generally, this is [[relativeFilePath(#heading)?(|display text|)?]] e.g. [[articles/markdown oxide#Features|Markdown Oxide Features]] to link to a heading in `Markdown Oxide.md` file in the `articles` folder or [[Obsidian]] for the `Obsidian.md` file in the root folder. @@ -98,21 +98,21 @@ Generally, this is [[relativeFilePath(#heading)?(|display text|)?]] e.g. [[artic - [X] File references [[file]] - [X] Heading references [[file#heading]] - [X] Block references. [[file#^index]] (I call indexed blocks the blocks that you directly link to. The link will look like [[file#^index]]. When linking from the obsidian editor, an *index* ^index is appended to the paragraph/block you are referencing) - - [X] Tags #tag and #tag/subtag/.. + - [X] Tags #tag and #tag/subtag/\.\. - [X] Footnotes: "paraphrased text[^footnoteindex]" - [ ] Metadata tag - Get references - - [X] For File when cursor is on the first character of the first line of the file. This will produce references not only to the file but also to headings and blocks in the file - - [X] For block when the cursor is on the blocks index "...text *^index*" - - [X] For tag when the cursor is on the tags declaration. Unlike go to definition for tags, this will produce all references to the tag and to the tag with subtags + - [X] For File when the cursor is on the **first character of the first line** of the file. This will produce references not only to the file but also to headings and blocks in the file + - [X] For block when the cursor is on the block's index "...text *^index*" + - [X] For tag when the cursor is on the tags declaration. Unlike go-to-definition for tags, this will produce all references to the tag and to the tag with subtags - [X] Footnotes when the cursor is on the declaration line of the footnote; *[^1]: description...* -- Completions (requires extra nvim cmp config; follow the directions above) +- Completions (requires extra nvim-cmp config; follow the directions above) - [X] File link completions - [X] Heading link Completions - - [ ] Subheading compeltions in the form [[file#heading#subheading]] from https://help.obsidian.md/Linking+notes+and+files/Internal+links#Link+to+a+heading+in+a+note (Note: right now you can link to subheadings through [[file#subheading]]) + - [ ] Subheading completions in the form [[file#heading#subheading]] from https://help.obsidian.md/Linking+notes+and+files/Internal+links#Link+to+a+heading+in+a+note (Note: right now you can link to subheadings through [[file#subheading]]) - [X] Block link completions (searches the text of the block) - [X] Footnote link completions - - [X] New Block link Completions through grep: to use this, type `[[ `, and after you press space, completions for every block in the vault will appear; continue typing to fuzzy match the block that you want; finally, select the block; a link will be inserter to the text document and an index (ex ^1j239) will be appended to the block in its respective file + - [X] New Block link Completions through grep: to use this, type `[[`, and after you press space, completions for every block in the vault will appear; continue typing to fuzzy match the block that you want; finally, select the block; a link will be inserted to the text document and an index (ex ^1j239) will be appended to the block in its respective file - [ ] Callout/admonition completions - [ ] Metadata completions - [ ] Dataview completions @@ -125,7 +125,7 @@ Generally, this is [[relativeFilePath(#heading)?(|display text|)?]] e.g. [[artic - [X] Footnotes - [ ] Code Actions - [x] Unresolved file link -> Create the file - - [x] Unresolved heading link -> append heading to file and create file + - [x] Unresolved heading link -> append heading to file and create the file if necessary - [ ] Link suggestions (by text match or other) - [ ] Refactoring: Move headers or selections to a new file - [ ] Link an unlinked reference @@ -135,7 +135,7 @@ Generally, this is [[relativeFilePath(#heading)?(|display text|)?]] e.g. [[artic - [ ] Unlinked reference - [X] Symbols - [X] File symbols: Headings and subheadings - - [X] Workspace headings: everythign linkable: files, headings, tags, ... Like a good search feature + - [X] Workspace headings: everything linkable: files, headings, tags, ... Like a good search feature - [ ] Lists and indented lists - [ ] Rename - [X] File (cursor must be in the first character of the first line) @@ -146,9 +146,9 @@ Generally, this is [[relativeFilePath(#heading)?(|display text|)?]] e.g. [[artic - [ ] Take some influence from LogSeq!!!!! https://docs.logseq.com/#/page/start%20here - [ ] Support Logseq syntax and completions/parsing for block references - [ ] Support Logseq embeds - - [ ] Support Completions for logseq tasks + - [ ] Support Completions for Logseq tasks - [ ] Support https://docs.logseq.com/#/page/markdown - - [ ] Influence from logseq shortcut completions; such as to dates like /tomorrow + - [ ] Influence from Logseq shortcut completions; such as to dates like /tomorrow - Config * [ ] Daily notes format * \[ \] (Opt-in dictionary or prose checking? Markdown syntax specific, of course; I am not sure how I feel about this feature yet; Let me know your thoughts)