Skip to content

Commit b8259cd

Browse files
author
Sethen Maleno
committed
Tweaked documentation, took out gulp, tweaked travis.yml file
1 parent 71c310f commit b8259cd

File tree

7 files changed

+19
-24
lines changed

7 files changed

+19
-24
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
language: node_js
22
node_js:
33
- "0.12"
4-
script: gulp test
4+
script: npm run test

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ markdown-include is built using Node.js and allows you to include markdown files
3737

3838
## Compile your markdown files
3939

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:
4141

4242
```
4343
#include "markdown-file.md"
4444
#include "another-markdown-file.md"
4545
```
4646

47-
Assuming that `markdown.file.md` contents are:
47+
And assuming that `markdown.file.md` contents are:
4848

4949
```
5050
Something in markdown file!
@@ -63,9 +63,11 @@ Something in markdown file!
6363
Something in another markdown file!
6464
```
6565

66+
Pretty neat, huh?
67+
6668
## Make a table of contents
6769

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.
6971

7072
For each heading that you would like to be included in a table of contents just add ` !heading` to the end of it.
7173

@@ -541,7 +543,7 @@ markdownInclude.writeFile('contents').then(function (data) {
541543
---
542544
# How To Make Custom Tags
543545

544-
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.
545547

546548
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.
547549

docs/how_to_make_custom_tags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# How To Make Custom Tags !heading
22

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.
44

55
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.
66

docs/markdown_include.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ markdown-include is built using Node.js and allows you to include markdown files
66

77
## Compile your markdown files !heading
88

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:
1010

1111
```
1212
#include "markdown-file.md" !ignore
1313
#include "another-markdown-file.md" !ignore
1414
```
1515

16-
Assuming that `markdown.file.md` contents are:
16+
And assuming that `markdown.file.md` contents are:
1717

1818
```
1919
Something in markdown file!
@@ -32,9 +32,11 @@ Something in markdown file!
3232
Something in another markdown file!
3333
```
3434

35+
Pretty neat, huh?
36+
3537
## Make a table of contents !heading
3638

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.
3840

3941
For each heading that you would like to be included in a table of contents just add ` !heading` to the end of it.
4042

gulpfile.js

Lines changed: 0 additions & 11 deletions
This file was deleted.

markdown-include.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/**
22
* @author Sethen Maleno (https://github.com/sethen)
33
* @description Include markdown files into other markdown files
4-
* @version 0.4.0
4+
* @version 0.4.1
55
*/
66

77
/* eslint-env node */

package.json

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "markdown-include",
3-
"version": "0.4.0",
3+
"version": "0.4.1",
44
"description": "Include markdown files into other markdown files with C style syntax.",
55
"main": "markdown-include.js",
66
"repository": {
@@ -22,11 +22,13 @@
2222
},
2323
"homepage": "https://github.com/sethen/markdown-include",
2424
"devDependencies": {
25-
"gulp": "^3.8.11",
26-
"gulp-shell": "^0.4.0",
2725
"intern": "^2.2.2"
2826
},
2927
"dependencies": {
3028
"q": "^1.2.0"
29+
},
30+
"scripts": {
31+
"docs": "./bin/cli.js markdown.json",
32+
"test": "node_modules/.bin/intern-client config=tests/intern.js"
3133
}
3234
}

0 commit comments

Comments
 (0)