Open GrahamSH-LLK opened 3 years ago
I would add that it could really use a guide as well.
The Vue.js website has been lauded as the gold standard for documentation. It splits the site into 2 parts
Array[string]
, string[]
, [key: string]: any
, or { [key: string]: Function }
. There NEEDS to be a page that just explains all of these cryptic variations on type descriptors, and it would fit perfectly in the guide.try this https://github.com/kejunmao/jsdoc
preview: https://vjsdoc.netlify.app/
JSDoc is amazing, but it's docs are hard to use and somewhat ugly. I've outlined some issues below.
No sidebar
When you go to a page, you have to go back to the home page to find other pages. This makes it harder to find interesting pages.
2010 styling
The website looks like it's from 2010. It's pretty bad.
No search
If you can't search, you have to find pages yourself. Something like Algolia Docsearch is free and easy to implement.