Skip to content

Commit

Permalink
Tweaked documentation, took out gulp, tweaked travis.yml file
Browse files Browse the repository at this point in the history
  • Loading branch information
Sethen Maleno committed Jun 13, 2015
1 parent 71c310f commit b8259cd
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 24 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
language: node_js
node_js:
- "0.12"
script: gulp test
script: npm run test
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ markdown-include is built using Node.js and allows you to include markdown files

## Compile your markdown files

markdown-include's main feature is that it allows you to include allows you to include markdown files into other markdown files, like so:
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:

```
#include "markdown-file.md"
#include "another-markdown-file.md"
```

Assuming that `markdown.file.md` contents are:
And assuming that `markdown.file.md` contents are:

```
Something in markdown file!
Expand All @@ -63,9 +63,11 @@ Something in markdown file!
Something in another markdown file!
```

Pretty neat, huh?

## Make a table of contents

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

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

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

Custom tags are now supported as of 0.3.2 of markdown-include. Adding custom tags to your documentation is quite easy to do.
Custom tags are now supported as of 0.4.0 of markdown-include. Adding custom tags to your documentation is quite easy to do.

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/how_to_make_custom_tags.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How To Make Custom Tags !heading

Custom tags are now supported as of 0.3.2 of markdown-include. Adding custom tags to your documentation is quite easy to do.
Custom tags are now supported as of 0.4.0 of markdown-include. Adding custom tags to your documentation is quite easy to do.

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.

Expand Down
8 changes: 5 additions & 3 deletions docs/markdown_include.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ markdown-include is built using Node.js and allows you to include markdown files

## Compile your markdown files !heading

markdown-include's main feature is that it allows you to include allows you to include markdown files into other markdown files, like so:
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:

```
#include "markdown-file.md" !ignore
#include "another-markdown-file.md" !ignore
```

Assuming that `markdown.file.md` contents are:
And assuming that `markdown.file.md` contents are:

```
Something in markdown file!
Expand All @@ -32,9 +32,11 @@ Something in markdown file!
Something in another markdown file!
```

Pretty neat, huh?

## Make a table of contents !heading

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

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

11 changes: 0 additions & 11 deletions gulpfile.js

This file was deleted.

2 changes: 1 addition & 1 deletion markdown-include.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @author Sethen Maleno (https://github.com/sethen)
* @description Include markdown files into other markdown files
* @version 0.4.0
* @version 0.4.1
*/

/* eslint-env node */
Expand Down
8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "markdown-include",
"version": "0.4.0",
"version": "0.4.1",
"description": "Include markdown files into other markdown files with C style syntax.",
"main": "markdown-include.js",
"repository": {
Expand All @@ -22,11 +22,13 @@
},
"homepage": "https://github.com/sethen/markdown-include",
"devDependencies": {
"gulp": "^3.8.11",
"gulp-shell": "^0.4.0",
"intern": "^2.2.2"
},
"dependencies": {
"q": "^1.2.0"
},
"scripts": {
"docs": "./bin/cli.js markdown.json",
"test": "node_modules/.bin/intern-client config=tests/intern.js"
}
}

0 comments on commit b8259cd

Please sign in to comment.