Skip to content
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

How to convert to HTML? #37

Closed
thealjey opened this issue Nov 13, 2015 · 1 comment
Closed

How to convert to HTML? #37

thealjey opened this issue Nov 13, 2015 · 1 comment
Labels

Comments

@thealjey
Copy link

Sorry for a noob question, but how do I actually use this to generate normal human-readable documentation?
Also, if there is other non-react code on the project, will this also be able to document that?

@fkling
Copy link
Member

fkling commented Nov 13, 2015

Since the output is JSON, you can process the JSON in any way you want. E.g. you could pass it to your favorite HTML template engine or build the HTML manually.

In example/ you will find some code that converts the JSON blob to Markdown (which in turn can be converted to HTML).

@fkling fkling closed this as completed Jan 4, 2016
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants