Skip to content
Browse files

Add safewords, expose markdown function

  • Loading branch information...
1 parent cd5abef commit 30bd0b1764aa055f4fbe619fd5c2ffa9f34ea87a @gjtorikian committed Dec 10, 2012
Showing with 7 additions and 10 deletions.
  1. +3 −7 README.md
  2. +1 −1 index.js
  3. +2 −1 lib/generator.js
  4. +1 −1 package.json
View
10 README.md
@@ -8,12 +8,7 @@ This is a documentation build system that takes Markdown files as sources, and p
## Features
- - Markdown syntax using [NAMP](https://github.com/gjtorikian/namp). NAMP supports:
- * [The standard Gruber syntax](http://daringfireball.net/projects/markdown/)
- * [The GitHub Flavored Markdown syntax](http://github.github.com/github-flavored-markdown/) (including language-specific codeblock fences)
- * Strikethroughs
- * Conversion of `Note: `, `Tip: `, and `Warning: ` blocks into [Twitter Bootstrap alert blocks](http://twitter.github.com/bootstrap/components.html#alerts)
- For more information, check out the NAMP documentation.
+ - Markdown syntax using [NAMP](https://github.com/gjtorikian/namp).
- Support for [content references (conrefs) in Markdown](https://github.com/gjtorikian/markdown_conrefs)
- Pass in individual files or entire directories; exclude files and directories with glob matching
- Embeddable metadata
@@ -66,7 +61,7 @@ There are a number of arguments you can pass to Panda that affect the entire bui
* `--keepFirstHeader` If set, keeps the first header (`<h1>`) detected
* `--baseUrl STRING ` Base url of all links [./]
* `--keepOutDir` Does not wipe output directory before building (defaults to `false`)
-
+* `--safeWords` An array of words not to complain about when performing a spellcheck test
## Jade Templates
@@ -81,6 +76,7 @@ You have to specify at least one Jade file as a template for your pages. Within
* `title` is the title of the documentation
* `pageTitle` is the title of the current page
* `mtime` indicates the last modified time of your source file
+* `markdown` references the Markdown converter; since this is based on namp, you'll want to add `.html` at the end to get the actual HTML
All your passed in `options` are also available.
View
2 index.js
@@ -94,7 +94,7 @@ panda_docs.make = exports.make = function(paths, _options, callback) {
if (err) return callback(err);
if (options.disableTests !== true) {
- funcDocs.runTests([destDir], {stopOnFail: false, ext: ".html"}, function(err) {
+ funcDocs.runTests([destDir], {stopOnFail: false, ext: ".html", safeWords: options.safeWords}, function(err) {
if (err) return callback(err);
return callback(null, cbReturn);
View
3 lib/generator.js
@@ -49,7 +49,8 @@ Generator.render = function(options, jadeCompileFn, filepath, filename, srcConte
fileName: filename,
whoAmI: filepath,
pageTitle: found.name,
- mtime: mtime
+ mtime: mtime,
+ markdown: helpers.markdown
});
var html = jadeCompileFn(jadeParams);
View
2 package.json
@@ -1,6 +1,6 @@
{
"name": "panda-docs",
- "version": "0.4.1",
+ "version": "0.4.3",
"author": "Garen Torikian",
"keywords": ["documentation", "docs", "markdown"],
"description": "A complete documentation generation tool for Markdown files",

0 comments on commit 30bd0b1

Please sign in to comment.
Something went wrong with that request. Please try again.