New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

--theme for Markdown #550

azu opened this Issue Sep 16, 2016 · 4 comments


None yet
3 participants
Copy link

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?


This comment has been minimized.

Copy link

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.


This comment has been minimized.

Copy link

azu commented Sep 17, 2016

--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 example.js
# simulate `documentation readme`
# npm i -g add-text-to-markdown
# echo | add-text-to-markdown path/to/ --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 ./ --section "Example Output" example.js 

This comment has been minimized.

Copy link

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

tmcw added a commit that referenced this issue Dec 29, 2016


This comment has been minimized.

Copy link

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