Skip to content

tejjyassin/docs

Repository files navigation

Protocol

Protocol is a Tailwind UI site template built using Tailwind CSS and Next.js.

Getting started

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

npm install

Next, run the development server:

npm run 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/mdx/search.mjs file.

License

This site template is a commercial product and is licensed under the Tailwind UI license.

Learn more

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

About

Dedicated Nextjs template for my website's documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published