Skip to content

NatLabRockies/cpd-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 

Repository files navigation

cpd-docs

Getting Started

The CPD User Guide uses Docsify.js. The site is served by GitHub Pages from the main branch at https://cpd-docs.chemcatbio.org: when the user opens the page, the index.html directs their browser to load the Docsify intepreter and render the page.

For local preview, first ensure Node.js is installed on your machine. Then install Docsify globally:

npm i docsify-cli -g

To preview the site and watch your changes live, run the following from the cpd-docs repository folder:

docsify serve docs

Adding Pages

Docsify automatically finds (and creates routes to) any Markdown pages added to the docs folder. In each folder, the README.md file becomes the homepage for that folder. If you add a visualizations subdirectory to docs and create README.md and Sankey.md files in that directory, those can be accessed at /visualizations/ and /visualizations/Sankey, respectively. See this Docsify page for more details.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors