Skip to content

Commit 2cf8429

Browse files
authored
docs(markdown): Document approaches to Markdown theming (#647)
Fixes #550
1 parent 88c8f9a commit 2cf8429

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/THEMING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,11 @@ or an array of [vinyl](https://github.com/gulpjs/vinyl) `File` objects.
2222
The theme is free to implement HTML generation however it chooses. See
2323
[the default theme](https://github.com/documentationjs/documentation-theme-default/)
2424
for some ideas.
25+
26+
### Theming Markdown
27+
28+
The default Markdown generator for documentation.js isn't customizable - instead
29+
of a plain-text theme, it's generated by creating an AST and then rendering
30+
it with [remark](http://remark.js.org/). If you need something extra in Markdown,
31+
you can either rally for that thing to be included in the default theme,
32+
or you can hack around it by using an HTML theme that outputs Markdown.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy