The docs theme is based on the protocol tailwind theme, with a bunch of modifications. Protocol is a Tailwind UI site template built using Tailwind CSS and Next.js.
You'll need node to run locally. To get started with this template, first install the npm dependencies:
npm installNext, run the development server:
npm run devFinally, open http://localhost:3000 in your browser to view the website.
Our docs are generated. Use the following steps to make adjustments to the content and update the website to match:
- make your edits to the documentation in the
api-code-examples/api.mjsfile - cd into the
scriptsfolder - run
npm installif you have not run it in this folder previously - run
node generate-api-pages.jsto generate the doc files for the website
Follow the style that has already been layed out. But as a general rule of thumb, follow normal English punctuation, but favor brevity over proper grammar. In other words, use capital letters at the start of sentences, and end them with a period, but sentences can be fragments if that gets the point across quicker.
To learn more about the technologies used in this site template, see the following resources:
- Tailwind CSS - the official Tailwind CSS documentation
- Next.js - the official Next.js documentation
- Headless UI - the official Headless UI documentation
- Framer Motion - the official Framer Motion documentation
- MDX - the official MDX documentation
- Algolia Autocomplete - the official Algolia Autocomplete documentation
- FlexSearch - the official FlexSearch documentation
- Zustand - the official Zustand documentation