To get started with this template, first install the npm dependencies:
npm install
cp .env.example .env.localNext, run the development server:
npm run devFinally, open http://localhost:3010 in your browser to view the website.
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=
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