Protocol is a Tailwind UI site template built using Tailwind CSS and Next.js.
Video: https://www.youtube.com/watch?v=tLQPuy2L8Vw&feature=youtu.be
To get started with this template, first install the yarn dependencies:
yarn
cp .env.example .env.local
Next, run the development server:
yarn dev
Finally, open http://localhost:3000 in your browser to view the website.
CREATE YOUR FIRTS PAGE DOCUMENTATION Into src/pages create or edit the pages in whick you work
don´t forget export a const description into your mdx page and the title'page
it must looks like:
export const description = 'YOUR_DESCRIPTION_HERE'
# YOUR_TITLE_HERE
...
SOME WHEREVER ELSE
You can start editing this template by modifying the files in the /src
folder. The site will auto-update as you edit these files.
By default this template uses Algolia DocSearch for the global search. DocSearch is free for open-source projects, and you can sign up for an account on their website. Once your DocSearch account is ready, update the following environment variables in your project with the values provided by Algolia:
NEXT_PUBLIC_DOCSEARCH_APP_ID=
NEXT_PUBLIC_DOCSEARCH_API_KEY=
NEXT_PUBLIC_DOCSEARCH_INDEX_NAME=
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
- Zustand - the official Zustand documentation