This repository has been archived by the owner on Jun 2, 2020. It is now read-only.
Build markdown API docs for JS and Go packages #43
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This hacky little script builds API reference docs in markdown for a given JS or Go package. It's not wired up to the build yet since it depends on a change in aegir.
Examples:
These end up in
content/pkg/{js,go}-ipfs-api
where they're picked up by Hugo, which renders them athttps://docsdev.ipfs.team/pkg/{js,go}-ipfs-api
.These currently both render godoc2md's and documentation.js's default markdown templates -- we can customize them as we see fit.