mirror of
https://github.com/documentationjs/documentation.git
synced 2026-01-18 14:17:30 +00:00
21 lines
811 B
Markdown
21 lines
811 B
Markdown
# HTML Themes
|
|
|
|
HTML themes for documentation consist of three parts
|
|
|
|
* `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.
|