mirror of
https://github.com/versia-pub/docs.git
synced 2025-12-06 06:18:19 +01:00
47 lines
2 KiB
Markdown
47 lines
2 KiB
Markdown
# Protocol
|
|
|
|
Protocol is a [Tailwind UI](https://tailwindui.com) site template built using [Tailwind CSS](https://tailwindcss.com) and [Next.js](https://nextjs.org).
|
|
|
|
## Getting started
|
|
|
|
To get started with this template, first install the npm dependencies:
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
Next, run the development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
Finally, open [http://localhost:3000](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](https://github.com/nextapps-de/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](https://tailwindui.com/license).
|
|
|
|
## Learn more
|
|
|
|
To learn more about the technologies used in this site template, see the following resources:
|
|
|
|
- [Tailwind CSS](https://tailwindcss.com/docs) - the official Tailwind CSS documentation
|
|
- [Next.js](https://nextjs.org/docs) - the official Next.js documentation
|
|
- [Headless UI](https://headlessui.dev) - the official Headless UI documentation
|
|
- [Framer Motion](https://www.framer.com/docs/) - the official Framer Motion documentation
|
|
- [MDX](https://mdxjs.com/) - the official MDX documentation
|
|
- [Algolia Autocomplete](https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/) - the official Algolia Autocomplete documentation
|
|
- [FlexSearch](https://github.com/nextapps-de/flexsearch) - the official FlexSearch documentation
|
|
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - the official Zustand documentation
|