developmentseed / developmentseed/doc-seed
Experience doc-seed vs Docusaurus
- Dominant language
- JavaScript
- Stars
- 3
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
For AF Elections we needed a simple site for developer documentation. Even though we started with `doc-seed`, we ended up using [Docusaurus](docusaurus.io). This post briefly captures its advantages and disadvantages.
The live site is here: http://devseed.com/af-elections-docs/docs/results
## :+1: Docusaurus
1. The first and second level navigation is manually configured. It's an extra step, but quicker and more intuitive than `doc-seed`'s automatically generated menu. This also provides more flexibility in how one organizes the markdown files. -> https://github.com/developmentseed/af-elections-docs/blob/master/website/sidebars.json
2. Contextual nav (right side) is auto-generated from markdown headings

3. Nice code highlighting with `highlight.js`, which was critical for the API-like documentation that we needed

4. It's a `npm` package :rocket:
## :+1: Doc Seed
1. The simple one-page is all we need. Docusaurus is very flexible and assumes a more complex site structure that we typically require. Removing the complexity takes time and I prefer `doc-seed`'s simple structure.
## Next time
The configurable navigation and code highlighting are great features of Docusaurus. If we bring that into `doc-seed`, I would use it for a similar documentation project next time.
cc @danielfdsilva @ricardomestre
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.