Skip to content

cleavr/docs-template

Repository files navigation

Documentation Site Template

This template is a paired down version of Cleavr's documentation website that you can use as a starter template for your own documentation website.

You can check out the docs template live preview to view and interact with the template.

Details

The template uses NuxtJS and relies on their Content module. Additional libraries used for the template can be found on the live preview landing page.

Feel free to fork this project and make your own.

Check out the accompanying tutorial series -

dev.to turial series

YouTube playlist series

Setup for local environment

# install dependencies
$ yarn install

# serve with hot reload at localhost:3000
$ yarn dev

Algolia Search

If you use the Algolia Search feature, the index will be created and delivered to your Algolia account during the site generation step for static sites.

This template has Nuxt Static site generation enabled; however, you can configure to run in SSR mode if you prefer. Though, you'd need to find a different method to compile your index for Algolia as the package plugin requires that static site generation to run.