You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,14 +37,14 @@ markdown-include is built using Node.js and allows you to include markdown files
37
37
38
38
## Compile your markdown files
39
39
40
-
markdown-include's main feature is that it allows you to include allows you to include markdown files into other markdown files, like so:
40
+
markdown-include's main feature is that it allows you to include markdown files into other markdown files. For example, you could place the following into a markdown file:
41
41
42
42
```
43
43
#include "markdown-file.md"
44
44
#include "another-markdown-file.md"
45
45
```
46
46
47
-
Assuming that `markdown.file.md` contents are:
47
+
And assuming that `markdown.file.md` contents are:
48
48
49
49
```
50
50
Something in markdown file!
@@ -63,9 +63,11 @@ Something in markdown file!
63
63
Something in another markdown file!
64
64
```
65
65
66
+
Pretty neat, huh?
67
+
66
68
## Make a table of contents
67
69
68
-
Aside from compiling your markdown files, markdown-include can also build your table of contents. This works by evaluating the heading tags inside of your files. Since markdown works on using `#` for headings, this makes it easy to assemble table of contents from them. The more `#` you have in front of your headings (up to 6) will decide how the table of contents is built. Use one `#` and it's a top level navigation item... Use two `#` and it would be underneath the previous navigation item and so on.
70
+
Aside from compiling your markdown files, markdown-include can also build your table of contents. This works by evaluating the heading tags inside of your files. Since markdown works on using `#` for making HTML headings, this makes it easy to assemble table of contents from them. The more `#` you have in front of your headings (up to 6) will decide how the table of contents is built. Use one `#` and it's a top level navigation item... Use two `#` and it would be underneath the previous navigation item and so on.
69
71
70
72
For each heading that you would like to be included in a table of contents just add ` !heading` to the end of it.
Custom tags are now supported as of 0.3.2 of markdown-include. Adding custom tags to your documentation is quite easy to do.
546
+
Custom tags are now supported as of 0.4.0 of markdown-include. Adding custom tags to your documentation is quite easy to do.
545
547
546
548
Custom tags can only be used when markdown-include is being required as a module. If you wish to make this available via the command line, you must require markdown-include in a node module and call it from the command line.
Copy file name to clipboardExpand all lines: docs/how_to_make_custom_tags.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# How To Make Custom Tags !heading
2
2
3
-
Custom tags are now supported as of 0.3.2 of markdown-include. Adding custom tags to your documentation is quite easy to do.
3
+
Custom tags are now supported as of 0.4.0 of markdown-include. Adding custom tags to your documentation is quite easy to do.
4
4
5
5
Custom tags can only be used when markdown-include is being required as a module. If you wish to make this available via the command line, you must require markdown-include in a node module and call it from the command line.
Copy file name to clipboardExpand all lines: docs/markdown_include.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,14 +6,14 @@ markdown-include is built using Node.js and allows you to include markdown files
6
6
7
7
## Compile your markdown files !heading
8
8
9
-
markdown-include's main feature is that it allows you to include allows you to include markdown files into other markdown files, like so:
9
+
markdown-include's main feature is that it allows you to include markdown files into other markdown files. For example, you could place the following into a markdown file:
10
10
11
11
```
12
12
#include "markdown-file.md" !ignore
13
13
#include "another-markdown-file.md" !ignore
14
14
```
15
15
16
-
Assuming that `markdown.file.md` contents are:
16
+
And assuming that `markdown.file.md` contents are:
17
17
18
18
```
19
19
Something in markdown file!
@@ -32,9 +32,11 @@ Something in markdown file!
32
32
Something in another markdown file!
33
33
```
34
34
35
+
Pretty neat, huh?
36
+
35
37
## Make a table of contents !heading
36
38
37
-
Aside from compiling your markdown files, markdown-include can also build your table of contents. This works by evaluating the heading tags inside of your files. Since markdown works on using `#` for headings, this makes it easy to assemble table of contents from them. The more `#` you have in front of your headings (up to 6) will decide how the table of contents is built. Use one `#` and it's a top level navigation item... Use two `#` and it would be underneath the previous navigation item and so on.
39
+
Aside from compiling your markdown files, markdown-include can also build your table of contents. This works by evaluating the heading tags inside of your files. Since markdown works on using `#` for making HTML headings, this makes it easy to assemble table of contents from them. The more `#` you have in front of your headings (up to 6) will decide how the table of contents is built. Use one `#` and it's a top level navigation item... Use two `#` and it would be underneath the previous navigation item and so on.
38
40
39
41
For each heading that you would like to be included in a table of contents just add ` !heading` to the end of it.
0 commit comments