Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Add esdoc documentation generator #156

Merged
merged 5 commits into from Apr 8, 2019
Merged

Add esdoc documentation generator #156

merged 5 commits into from Apr 8, 2019

Conversation

daniyarchambylov
Copy link
Collaborator

Run npm run esdoc to generate documentation in docs/ folder

@dmuhs
Copy link
Contributor

dmuhs commented Apr 1, 2019

Works for me and looks super neat! Under "source" in the index.html we even have documentation coverage built in, similar to here. Could we get the badge into the readme? On https://doc.esdoc.org/-/generate.html we can also build the docs if we provide an esdoc.json in our project root. Could you add this as well? From there we could probably also get the badge

Copy link
Contributor

@dmuhs dmuhs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor nitpick to link the readme badge. Apart from that, great!

README.md Outdated Show resolved Hide resolved
Co-Authored-By: daniyarchambylov <dan.chambylov@gmail.com>
@daniyarchambylov daniyarchambylov merged commit 83a052a into master Apr 8, 2019
@daniyarchambylov daniyarchambylov deleted the esdoc branch April 8, 2019 10:48
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants