docmedown 0.9.1 → 0.9.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -2
- package/dist/cli.js +128 -128
- package/dist/docmedown.cjs +4 -4
- package/dist/docmedown.iife.js +4 -4
- package/dist/docmedown.mjs +9 -4
- package/dist/docmedown.web.js +4 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -41,10 +41,13 @@ Drop a single `index.html` file into any directory of `.md` files, and you have
|
|
|
41
41
|
### Option 1: Using the CLI Tool
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
|
-
#
|
|
45
|
-
|
|
44
|
+
# Run at your project root: detects root .md files (README, CONTRIBUTING, CHANGELOG, etc.)
|
|
45
|
+
# and links both root and the ./docs/ folder by default!
|
|
46
|
+
npx docmedown
|
|
46
47
|
```
|
|
47
48
|
|
|
49
|
+
> **Automatic Root Markdown Linking**: Real-world projects typically keep `.md` files at their repository root (`README.md`, `CONTRIBUTING.md`, `CHANGELOG.md`, `ROADMAP.md`). When running `docmedown`, it detects `.md` files at your current directory and links them directly alongside your `./docs/` folder by default. All root and `./docs/` documents appear seamlessly at the top level of your documentation without creating an unnecessary `./docs/` subdivision.
|
|
50
|
+
|
|
48
51
|
To configure branding, themes, or remote GitHub repository sources with an interactive terminal wizard:
|
|
49
52
|
|
|
50
53
|
```bash
|