OpenSourceArk/obsidian-export
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updating docs to reflect updated remove-comments flag.

Browse Source
This commit is contained in:
Jason Thompson 2024-08-05 23:30:20 -04:00
parent 45de00ebdc
commit e3aa83de30
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/usage-advanced.md
View File

@ -121,7 +121,9 @@ With these hooks in place, links to both notes as well as file attachments shoul
## Removing Obsidian comments ## Removing Obsidian comments
To remove [Obsidian formatted comments](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Comments) you can set the `--remove-obsidian-comments` flag. This will remove inline as well as block comments but leave any comments found in codeblocks. By default, comments are kept unchanged in the output.
To remove [Obsidian formatted comments](https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax#Comments) you can set the `--comments=remove` flag. This will remove inline as well as block comments but leave any comments found in codeblocks.
```md ```md
This is not a comment. This is not a comment.
@ -134,10 +136,12 @@ block comment and
all of this would be removed all of this would be removed
%% %%
``` ```
With the `--remove-obsidian-comments` flag. This file would output as With the `--comments=remove` flag. This file would output as
```md ```md
This is not a comment This is not a comment
This line could have more text. This line could have more text.
``` ```
> Note: Comments within codeblocks are left untouched