Skip to content

Commit

Permalink
docs(markdown): Document approaches to Markdown theming (#647)
Browse files Browse the repository at this point in the history
Fixes #550
  • Loading branch information
tmcw authored Dec 29, 2016
1 parent 88c8f9a commit 2cf8429
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/THEMING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,11 @@ or an array of [vinyl](https://github.com/gulpjs/vinyl) `File` objects.
The theme is free to implement HTML generation however it chooses. See
[the default theme](https://github.com/documentationjs/documentation-theme-default/)
for some ideas.

### Theming Markdown

The default Markdown generator for documentation.js isn't customizable - instead
of a plain-text theme, it's generated by creating an AST and then rendering
it with [remark](http://remark.js.org/). If you need something extra in Markdown,
you can either rally for that thing to be included in the default theme,
or you can hack around it by using an HTML theme that outputs Markdown.

0 comments on commit 2cf8429

Please sign in to comment.