robb-j / ocelot-template

The default template for rendering ocelot docs

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Ocelot Template

The default template when rendering Ocelot Docs

Template Structure

This template is compiled through Webpack and fulfils the requirement for an Ocelot template, providing the info.yml, index.pug and error.pug files.

Webpack is used to build the static assets which are copied in when the template is used, for this it uses Stylus for css and Vue for simple js interactions. The stylus compiled to minified css into assets/css. The javascript is polyfilled using Babel and minified into assets/js

Useful Commands

# Build the docs once
npm run build

# Watch the webpack
npm run dev

About

The default template for rendering ocelot docs


Languages

Language:JavaScript 39.0%Language:CSS 32.8%Language:HTML 21.7%Language:Vue 6.5%