--theme for Markdown #550

azu opened this Issue Sep 16, 2016 · 4 comments


None yet

3 participants

azu commented Sep 16, 2016

Hi, I want to customize output of markdown(-f md)/readme(-f remark?).
But, current --theme options support only html

Is there any chance that support combination markdown/readme and theme option?

arv commented Sep 16, 2016

--theme allows you to create anything. It may be a lot of work to write a new markdown theme but we could potentially refactor the current markdown output as a theme.

azu commented Sep 17, 2016 edited

--theme allows you to create anything.

I try to create a theme for markdown.

Actually work

documentation build --access public --theme ./node_modules/documentation-markdown-api-theme/lib/index -f html -o out.md example.js
# simulate `documentation readme`
# npm i -g add-text-to-markdown
# echo out.md | add-text-to-markdown path/to/file.md --section "section name" --write

But, I want to write following instead of the above un-readable command...

documentation readme --access public --theme documentation-markdown-api-theme --readme-file ./README.md --section "Example Output" example.js 
tmcw commented Dec 29, 2016

Using an HTML theme to generate Markdown is probably the best way to do Markdown theming for the future, as your example demonstrates. I'll document that approach in #647. Certainly open to a PR implementing another strategy for Markdown customization, but for now I'd like to focus my efforts on making the default Markdown output great.

@tmcw tmcw closed this in #647 Dec 29, 2016
azu commented Dec 31, 2016

Thanks for response.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment