Skip to content

davehg/documentationjs-theme-simple

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

documentation-theme-simple

This is a version of the default theme included in documentationjs. It uses Handlebars templates and a few assets: a highlight.js theme and basscss as a basic CSS framework.

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.
  • {{#if_eq val1 val2}}: conditional that checks if val1 and val2 are equal
  • `{{}}

About

A simple theme to use with documentationjs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published