Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
markdown-notes-tree
Advanced tools
markdown-notes-tree - npm Package Compare versions
Comparing version 1.10.0 to 1.10.1
| { | ||
| "name": "markdown-notes-tree", | ||
| "version": "1.10.0", | ||
| "version": "1.10.1", | ||
| "description": "Generate Markdown trees that act as a table of contents for a folder structure with Markdown notes", | ||
@@ -26,6 +26,6 @@ "main": "src/index.js", | ||
| "devDependencies": { | ||
| "codecov": "^3.6.5", | ||
| "codecov": "^3.7.1", | ||
| "dedent": "^0.7.0", | ||
| "fs-extra": "^8.1.0", | ||
| "jest": "^24.9.0", | ||
| "jest": "^26.1.0", | ||
| "prettier": "^1.19.1", | ||
@@ -32,0 +32,0 @@ "prettier-check": "^2.0.0" |
@@ -43,5 +43,5 @@ # markdown-notes-tree | ||
| Normally, the tool expects to find the note's title as a level 1 Markdown heading on the first line of the file. | ||
| Normally, the tool expects to find the note's title as a level 1 Markdown heading on the first line of the file (potentially after some YAML front matter). | ||
| However, if the note starts with YAML front matter that has a `tree_title` attribute, the value of `tree_title` will be used as the note's title in the tree. | ||
| However, if a note starts with YAML front matter that has a `tree_title` attribute, the value of `tree_title` will be used as the note's title in the tree. | ||
@@ -54,27 +54,64 @@ ## Subdirectory descriptions | ||
| If you specify a custom title for a subdirectory, it will be preserved and it will be used in the tree instead of the name of the subdirectory. | ||
| By default, the generated `README.md` files for subdirectories use the subdirectory's name as title. If you change this into a custom title, that custom title will be preserved and it will be used in the tree instead of the name of the subdirectory. | ||
| ## Command line arguments | ||
| - `--ignore`: Specify glob pattern for additional files or folders to ignore. You can use this argument multiple times in order to specify multiple glob patterns. | ||
| - Example: `markdown-notes-tree --ignore **/CONTRIBUTING.md` | ||
| - Example: `markdown-notes-tree --ignore CONTRIBUTING.md --ignore sub1/CONTRIBUTING.md` | ||
| - Example: `markdown-notes-tree --ignore exclude-this-folder` | ||
| - `--includeAllDirectoriesByDefault`: Include all directories by default (don't apply the default ignored folders listed above). You can combine this with custom ignores as needed. | ||
| - Example: `markdown-notes-tree --includeAllDirectoriesByDefault --ignore node_modules` | ||
| - `--linkToSubdirectoryReadme`: When linking to a subdirectory, link directly to its `README.md` file. Note that this assumes that each subdirectory will actually have a `README.md` file. By default, the tool generates these automatically. | ||
| - Example: `markdown-notes-tree --linkToSubdirectoryReadme` | ||
| - `--noSubdirectoryTrees`: Don't write `README.md` files to subdirectories. Any existing `README.md` files in subdirectories will be ignored. | ||
| - Example: `markdown-notes-tree --noSubdirectoryTrees` | ||
| - `--notesBeforeDirectories`: If a directory contains both notes and subdirectories, put the notes before the subdirectories in he tree. By default, it's the other way around. | ||
| - Example: `markdown-notes-tree --notesBeforeDirectories` | ||
| - `--orderNotesByTitle`: Order notes in the same (sub)directory by title instead of by filename. | ||
| - Example: `markdown-notes-tree --orderNotesByTitle` | ||
| - `--silent`: Don't log to the console during execution. | ||
| - Example: `markdown-notes-tree --silent` | ||
| - `--subdirectoryDescriptionOnNewLine`: If subdirectory descriptions are provided, put them on a new line in the tree. | ||
| - Example: `markdown-notes-tree --subdirectoryDescriptionOnNewLine` | ||
| - `--useTabs`: Use tabs (instead of the standard four spaces) for indentation. | ||
| - Example: `markdown-notes-tree --useTabs` | ||
| ### `--ignore` | ||
| Specify glob pattern for additional files or folders to ignore. You can use this argument multiple times in order to specify multiple glob patterns. | ||
| Example: `markdown-notes-tree --ignore **/CONTRIBUTING.md` | ||
| Example: `markdown-notes-tree --ignore CONTRIBUTING.md --ignore sub1/CONTRIBUTING.md` | ||
| Example: `markdown-notes-tree --ignore exclude-this-folder` | ||
| ### `--includeAllDirectoriesByDefault` | ||
| Include all directories by default (don't apply the default ignored folders listed above). You can combine this with custom ignores as needed. | ||
| Example: `markdown-notes-tree --includeAllDirectoriesByDefault --ignore node_modules` | ||
| ### `--linkToSubdirectoryReadme` | ||
| When linking to a subdirectory, link directly to its `README.md` file. Note that this assumes that each subdirectory will actually have a `README.md` file. By default, the tool generates these automatically. | ||
| Example: `markdown-notes-tree --linkToSubdirectoryReadme` | ||
| ### `--noSubdirectoryTrees` | ||
| Don't write `README.md` files to subdirectories. Any existing `README.md` files in subdirectories will be ignored. | ||
| Example: `markdown-notes-tree --noSubdirectoryTrees` | ||
| ### `--notesBeforeDirectories` | ||
| If a directory contains both notes and subdirectories, put the notes before the subdirectories in he tree. By default, it's the other way around. | ||
| Example: `markdown-notes-tree --notesBeforeDirectories` | ||
| ### `--orderNotesByTitle` | ||
| Order notes in the same (sub)directory by title instead of by filename. | ||
| Example: `markdown-notes-tree --orderNotesByTitle` | ||
| ### `--silent` | ||
| Don't log to the console during execution. | ||
| Example: `markdown-notes-tree --silent` | ||
| ### `--subdirectoryDescriptionOnNewLine` | ||
| If subdirectory descriptions are provided, put them on a new line in the tree. | ||
| Example: `markdown-notes-tree --subdirectoryDescriptionOnNewLine` | ||
| ### `--useTabs` | ||
| Use tabs (instead of the standard four spaces) for indentation. | ||
| Example: `markdown-notes-tree --useTabs` | ||
| ## Development | ||
@@ -81,0 +118,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.21%
54908
- Number of lines in readme file
- increased by43.53%
122
No dependency changes