From b8259cd90cc28b0dc4242c6689c9e16fe001cb45 Mon Sep 17 00:00:00 2001 From: Sethen Maleno Date: Sat, 13 Jun 2015 13:33:22 -0400 Subject: [PATCH] Tweaked documentation, took out gulp, tweaked travis.yml file --- .travis.yml | 2 +- README.md | 10 ++++++---- docs/how_to_make_custom_tags.md | 2 +- docs/markdown_include.md | 8 +++++--- gulpfile.js | 11 ----------- markdown-include.js | 2 +- package.json | 8 +++++--- 7 files changed, 19 insertions(+), 24 deletions(-) delete mode 100644 gulpfile.js diff --git a/.travis.yml b/.travis.yml index 0df9216..ed41dd2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,4 +1,4 @@ language: node_js node_js: - "0.12" -script: gulp test \ No newline at end of file +script: npm run test \ No newline at end of file diff --git a/README.md b/README.md index 502b5c5..c018ca0 100644 --- a/README.md +++ b/README.md @@ -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! @@ -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. @@ -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. diff --git a/docs/how_to_make_custom_tags.md b/docs/how_to_make_custom_tags.md index 159fa7a..86a8a19 100644 --- a/docs/how_to_make_custom_tags.md +++ b/docs/how_to_make_custom_tags.md @@ -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. diff --git a/docs/markdown_include.md b/docs/markdown_include.md index 0f742a7..50ed96c 100644 --- a/docs/markdown_include.md +++ b/docs/markdown_include.md @@ -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! @@ -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. diff --git a/gulpfile.js b/gulpfile.js deleted file mode 100644 index a3fceec..0000000 --- a/gulpfile.js +++ /dev/null @@ -1,11 +0,0 @@ -/* eslint-env node */ -var gulp = require('gulp'); -var shell = require('gulp-shell'); - -gulp.task('test', shell.task([ - 'node_modules/.bin/intern-client config=tests/intern.js' -])); - -gulp.task('build', shell.task([ - './bin/cli.js markdown.json' -])); \ No newline at end of file diff --git a/markdown-include.js b/markdown-include.js index 0f93bb7..315efb9 100644 --- a/markdown-include.js +++ b/markdown-include.js @@ -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 */ diff --git a/package.json b/package.json index c801522..84d075c 100644 --- a/package.json +++ b/package.json @@ -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": { @@ -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" } }