Code Monkey home page Code Monkey logo

rir-doc-tpl's Introduction

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.


rir-doc-tpl's People

Contributors

zupra avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.