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.

Sign up for GitHub

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

Jump to bottom

show or link service documentation #19

Open
blndev opened this issue Dec 8, 2016 · 2 comments
Open

show or link service documentation #19

blndev opened this issue Dec 8, 2016 · 2 comments
Labels
enhancement

Comments

@blndev
Copy link
Member

blndev commented Dec 8, 2016

maybe we can use a md - browser viewer or we should create a build step to place a html based documentation in html folder.

Research: Swagger for ExpressJS
@blndev
Copy link
Member Author

blndev commented Dec 8, 2016

Swagger seems to overblown currently. Different than in Java or C# you have to write a swagger.json for a express service by hand.

Better approach:
https://github.com/evilstreak/markdown-js
https://www.npmjs.com/package/markdown-to-html

@blndev
Copy link
Member Author

blndev commented Dec 9, 2016

MD to HTML used by Google: https://github.com/showdownjs/showdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@blndev