Skip to content

Commit 4111e61

Browse files
committed
added automatic md index
1 parent c857251 commit 4111e61

16 files changed

Lines changed: 1037 additions & 0 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Auto detect text files and perform LF normalization
2+
* text=auto
3+
4+
*.ts linguist-language=ts
5+
*.js linguist-language=js
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Ignore the build output directory
2+
dist/
3+
node_modules/
4+
markdown_output/
5+
.vs/
6+
*.tgz
7+
bun.lock
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.vs/
2+
src/
3+
test/
4+
node_modules/
5+
bun.lock
6+
.gitattributes
7+
*.tgz
8+
*.d.ts
9+
.npmrc
10+
tsconfig.json
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Shadowdara
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# automatic md index
2+
3+
a TS package to add Header Indexes to Markdown Files
4+
5+
<!--$$MD_INDEX_START$$-->
6+
<!--
7+
Index by Automatic MD Index
8+
a simple Tool to Index your Markdown files like this
9+
10+
More Infos:
11+
https://github.com/ShadowDara/automatic-md-index
12+
13+
DO NOT REMOVE THIS CREDIT !!!
14+
15+
Last Update Time of the Index:
16+
2025-12-05T13:11:51.473Z
17+
-->
18+
## Index
19+
- [automatic md index](#automatic-md-index)
20+
- [Infos](#infos)
21+
- [Generate the Index](#generate-the-index)
22+
- [Test](#test)
23+
- [Update the Readme Index](#update-the-readme-index)
24+
- [Adiotional Ideas](#adiotional-ideas)
25+
<!-- Index by Automatic MD Index -->
26+
<!--$$MD_INDEX_END$$-->
27+
28+
## Infos
29+
Run with --help for Infos
30+
31+
## Generate the Index
32+
33+
to generate the Index at the location in your Markdown file, add
34+
```
35+
<!--$$MD_INDEX$$-->
36+
```
37+
to it, and the Index will generated and updated there!
38+
39+
## Test
40+
run `npm run test`
41+
42+
## Update the Readme Index
43+
```
44+
# Command
45+
npm run updaterm
46+
```
47+
48+
## Adiotional Ideas
49+
- option to disable the 1. Heading
50+
- disable some headings
51+
- convert the Headings to html

packages/automatic-md-index/package-lock.json

Lines changed: 247 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)