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.
All docs are written in MDX which is a combination of Markdown and JSX. You can find the individual pages in the src/app directory.
The navigation structure is defined as a Javascript array called navigation in the src/components/Navigation.tsx file.
Make sure the href matches a folder in the src/app directory.
All documentation pages are written in MDX and can be found in the src/app directory. Each page should have a metadata object at the top of the file that defines the title and description of the page. The sections array should list all the sections on the page.
The directory where the page is located is used as the URL path. For example, a page in src/Patient will be available at /Patient.
Customization of the design and functionality is possible by modifying the React components in the src/components directory.
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/mdx/search.mjs file.
This site template is a commercial product and is licensed under the Tailwind UI license.
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