Giter Club home page Giter Club logo

cpd-docs's Introduction

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.

cpd-docs's People

Contributors

kvanalls avatar

Stargazers

 avatar

Watchers

James Cloos avatar National Renewable Energy Laboratory avatar  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.