Getting started

To get started with this site, first install the npm dependencies:

yarn install

Next, run the development server:

yarn dev

Finally, open http://localhost:3000 in your browser to view the website.

Customizing

You can start editing this template by modifying the files in the /src folder. The site will auto-update as you edit these files.

Global search

This template includes a global search that's powered by the FlexSearch library. It's available by clicking the search input or by using the ⌘K shortcut.

This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the /src/markdoc/search.mjs file.

Learn more

To learn more about the technologies used in this site, 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
• Markdoc - the official Markdoc documentation
• Algolia Autocomplete - the official Algolia Autocomplete documentation
• FlexSearch - the official FlexSearch documentation