Show HN: Sodocan.js: Documentation Made Easy

If you would like to some real examples of documentation created using Sodocan.js, check out http://jesterswilde.github.io/hashids/ and http://liujoycec.github.io/jwt-simple/ . These are both created from the Blueprints template Sodone. These templates are also open-source, and we would love for you to help us improve them and add more templates!

Re: Show HN: Sodocan.js: Documentation Made Easy

#5

Post by blainesch » Tue, Nov 10, 2015, 11:28 PM UTC

liujoycec wrote: post #4

If you would like to some real examples of documentation created using Sodocan.js, check out http://jesterswilde.github.io/hashids/ and http://liujoycec.github.io/jwt-simple/ . These are both created from the Blueprints template Sodone. These templates are also open-source, and we would love for you to help us improve them and add more templates!

The links on the side of both demos don't appear to do anything.

Re: Show HN: Sodocan.js: Documentation Made Easy

#6

Post by sdtsui » Tue, Nov 10, 2015, 11:29 PM UTC

Hey there. Where could an OSS project owner find a 'getting started' guide?

Re: Show HN: Sodocan.js: Documentation Made Easy

#7

Post by serrisande » Tue, Nov 10, 2015, 11:32 PM UTC

blainesch wrote: post #5

liujoycec wrote: post #4

If you would like to some real examples of documentation created using Sodocan.js, check out http://jesterswilde.github.io/hashids/ and http://liujoycec.github.io/jwt-simple/ . These are both created from the Blueprints template Sodone. These templates are also open-source, and we would love for you to help us improve them and add more templates!

The links on the side of both demos don't appear to do anything.

Thanks for pointing it out. This is a known bug that showed up in the deployment to gh-pages. We are currently looking into it.

Re: Show HN: Sodocan.js: Documentation Made Easy

#8

Post by liujoycec » Tue, Nov 10, 2015, 11:37 PM UTC

sdtsui wrote: post #6

Hey there. Where could an OSS project owner find a 'getting started' guide?

Thanks for your question! The 'Getting Started' guide can be found in the Github repo README at https://github.com/sodocan/sodocan.js. We will update our site to make that link more prominent.

Re: Show HN: Sodocan.js: Documentation Made Easy

#9

Post by codebeaker » Wed, Nov 11, 2015, 3:11 PM UTC

A shame that the page has to hijack the scroll functionality, it makes for a very unpleasant "lumpy" feeling scrolling. Chrome Version 46.0.2490.80 (64-bit) on OS X Yosemite.

Re: Show HN: Sodocan.js: Documentation Made Easy

#10

Post by IanCal » Wed, Nov 11, 2015, 3:15 PM UTC

This looks really interesting, thanks for sharing.

I'm finding it quite difficult to read through the main page however, as there's something going on with the scrolling. It's hyper-sensitive, then when there are animations on the page they play through before jumping me really far.