https://github.com/carrotsearch/gatsby-theme-apidocs

An opinionated Gatsby theme for writing technical documentation.
https://github.com/carrotsearch/gatsby-theme-apidocs

documentation-generator gatsby gatsby-theme

Last synced: about 1 month ago
JSON representation

An opinionated Gatsby theme for writing technical documentation.

• Host: GitHub
• URL: https://github.com/carrotsearch/gatsby-theme-apidocs
• Owner: carrotsearch
• Created: 2020-09-22T07:55:20.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-11-21T11:31:46.000Z (about 1 year ago)
• Last Synced: 2024-10-09T19:00:42.470Z (3 months ago)
• Topics: documentation-generator, gatsby, gatsby-theme
• Language: JavaScript
• Homepage: https://carrotsearch.github.io/apidocs/
• Size: 5.21 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# APIDocs Gatsby theme

APIdocs is an opinionated Gatsby theme for writing technical documentation.

[Complete documentation](https://carrotsearch.github.io/apidocs/)

---

## Features

Out-of-the-box APIdocs comes with:

- HTML-based content authoring,

- responsive, mobile-friendly layout,

- a dark and light color scheme,

- HighlightJS code highlighting,

- Sublime-style client-side search,

- medium.com style image zooming,

- near-100 Lighthouse score of the final static site.

---

## Quick start

See the [gatsby-starter-apidocs](https://github.com/carrotsearch/gatsby-starter-apidocs).