documentation-theme-node
documentationjs theme for node modules
Last updated 5 years ago by anandthakker .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install documentation-theme-node 
SYNC missed versions from official npm registry.

documentation-theme-default

This is the default theme for documentationjs: it consists of Handlebars templates and a few assets: a highlight.js theme and basscss as a basic CSS framework.

This is bundled by default in documentation: it is the default theme.

The contents are the following:

  • index.hbs, the main template that defines the document structure
  • section.hbs, a partial used to render each chunk of documentation
  • assets/*, any assets, including CSS & JS

Helpers

  • {{format_params}}: format function parameters, including the types included within.
  • {{permalink}}: in the context of a documentation chunk, return the chunk's permalink
  • {{autolink TEXT}}: given a chunk of text that may be a reference to a method, property, or other namespaced item, link the text to the item
  • {{md TEXT}}: render Markdown-formatted text, parsing additional JSDoc inline tag syntax and linking links when necessary
  • {{format_type}}: format a type definition, like {string} within a param definition.

Current Tags

  • 1.0.2                                ...           latest (5 years ago)

2 Versions

  • 1.0.2                                ...           5 years ago
  • 1.0.1                                ...           5 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (9)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |