Skip to content

seanmorris/cv2-doc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

avatar

cv2-doc v0.0.0

cv2-doc renders documentation renders documentation generated by idilic document.

cv2-doc can be hosted in github pages.

cv2-doc is serverless.

See an example here

Getting started

Set up your app/Config.js file:

export class Config {}

Config.title   = 'Ids - Sean Morris | cv2-doc'
Config.project = 'Ids'
Config.source  = 'https://raw.githubusercontent.com/seanmorris/ids/sm-dynamic-docs/asset/documentation.jsv';

Config.sourceRoot = 'https://github.com/seanmorris/ids/blob/master/';
Config.repository = 'seanmorris/ids';
Config.tagline    = 'The PHP + Docker Framework';

Config.author     = 'Sean Morris';
Config.copyright  = '2011 - 2020 Sean Morris';

Config.homeLinks  = {
	github:      'https://github.com/seanmorris/ids'
	, packagist: 'https://packagist.org/packages/seanmorris/ids'
};

Start up a dry run:

$ npm i -g brunch
$ npm i cv2-doc
$ brunch watch -s

Build compiled JS & CSS:

$ brunch build -p

About

Documentation renderer for idilic document.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published