Beautiful docs
docco
Beautiful docs | docco | |
---|---|---|
4 | 4 | |
8,896 | 3,544 | |
- | - | |
4.4 | 0.0 | |
about 2 months ago | 5 months ago | |
HTML | ||
MIT License | GNU General Public License v3.0 or later |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Beautiful docs
- 18 Must-Bookmark GitHub Repositories Every Developer Should Know
-
When creating writing portfolios for a job interview what hosting platform do you use/recommend? What advice would you give to someone creating their first writing portfolio?
If interested in static site/page generation, here is a useful link You could use some of the options and guides to generate a similar docs site for you to showcase your skills and work
-
GitHub's non-code features: exploring more of GitHub and encouraging your non-dev friends
Beautiful Documentation. A list of examples of good documentation.
-
what tools do people use for documentation?
I once asked a similar question in this subreddit lol.. and i was given a great resource which I now reshare: https://github.com/PharkMillups/beautiful-docs
docco
-
Ask HN: Show Code with Notes Alongside
i have seen those in annotated javascript documentation. but it was the other way around. (comment on the left, and code on the right).
they all seem to use docco[0] with the option to display comment in "parallel". the author of docco used it in their library underscore[1].
[0]: https://github.com/jashkenas/docco
- Docco is a quick-and-dirty documentation generator
-
Lisp.py
Side note - it's been a while since i've seen a Docco-style annotated-source-style documentation! http://ashkenas.com/docco/
Backbone.js was the first time i saw it, and I loved it! https://backbonejs.org/docs/backbone.html It demonstrated to me that the libraries I use are just normal code that other people write, and i myself can read it to understand a problem.
-
CSS Deep
jashkenas/docco - Literate Programming can be Quick and Dirty.
What are some alternatives?
documentation.js - :book: documentation for modern JavaScript
jsduck - Simple JavaScript Duckumentation generator.
ESDoc - ESDoc - Good Documentation for JavaScript
sphinx - The Sphinx documentation generator
coddoc
jsdox - simplified jsdoc 3
dox - JavaScript documentation generator for node using markdown and jsdoc
JSDoc - An API documentation generator for JavaScript.