@carrotsearch/gatsby-theme-apidocs

A Gatsby theme for creating functional and responsive API documentation websites.

Usage no npm install needed!

<script type="module">
  import carrotsearchGatsbyThemeApidocs from 'https://cdn.skypack.dev/@carrotsearch/gatsby-theme-apidocs';
</script>

README

APIDocs Gatsby theme

APIdocs is an opinionated Gatsby theme for writing technical documentation.

Features

Out-of-the-box APIdocs comes with:

  • HTML-based content authoring,
  • responsive, mobile-friendly layout,
  • a dark and light color scheme,
  • Prism.js code highlighting,
  • Sublime-style client-side search,
  • near-100 Lighthouse score of the final static site.

Quick start

🚧 Work in progress. 🚧