Code Monkey home page Code Monkey logo

docs-cdc's Introduction

Documentation for CDC

This repo contains the files that you need to work with the CDC docs. There are two branches: main and dev. main reflects the current docs and dev should reflect the current docs plus any work to go in to the next release. All PRs should be raised against dev and if applicable, cherry-picked to main. Merged PRs against main are published automatically.

The examples in this repo have a separate repo with executable variants: https://github.com/neo-technology/cdc-documentation-examples

Upon release of a minor version, the dev branch is merged into the main branch.

Prereqs

Installation

To install the required packages:

npm i

Generating HTML output

To convert asciidoc source to HTML:

npm run build

Viewing HTML output

To view the built site, launch a local server:

  1. npm start

  2. In a browser tab, go to localhost:8000

Live preview

When you run npm start, the project is monitored for updates to asciidoc files.

If a change to an asciidoc file is detected the site is automatically rebuilt.

docs-cdc's People

Contributors

l-heemann avatar stefano-ottolenghi avatar recrwplay avatar docrozza avatar alexicawright avatar dependabot[bot] avatar davidoliversp2 avatar fiquick avatar ali-ince avatar jpryce-aklundh avatar neo-ionut avatar robsdedude 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.