Source code for https://docs.storj.io
The docs are built using Tailwind CSS and Next.js.
If you're interested in contributing to Storj docs, please start by reading our CONTRIBUTING.md guide.
To get started, 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.
You can start editing by modifying the files in the /src folder. The site will auto-update as you edit these files.
The docs include 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/markdoc/search.mjs file.
To learn more about the technologies used in this site template, see the following resources:
- Tailwind UI base site template
- Tailwind CSS - the official Tailwind CSS documentation
- Next.js - the official Next.js documentation
- Headless UI - the official Headless UI documentation
- Markdoc - the official Markdoc documentation
- Algolia Autocomplete - the official Algolia Autocomplete documentation
- FlexSearch - the official FlexSearch documentation
