Code Monkey home page Code Monkey logo

qiciengine-documentation's Introduction

QICI Engine Documentation for API and user manuals

QICI Engine Documentation is created by GitBook using Markdown.

You can read QICI Engine Documentation online:

How to build

Here we use npm-run-script to install GitBook environment and convert Markdown to html.

For English Documentation:

npm run install-en
npm run init-en
npm run build-api-en
npm run build-manual-en

For Chinese Documentation:

npm run install-zh
npm run init-zh
npm run build-api-zh
npm run build-manual-zh

The commands above are defined in package.json

"scripts": {
	"install-zh": "npm install gitbook-cli && gitbook install zh/api && gitbook install zh/manual",
	"install-en": "npm install gitbook-cli && gitbook install en/api && gitbook install en/manual",
	"init-zh": "gitbook init zh/api && gitbook init zh/manual",
	"init-en": "gitbook init en/api && gitbook init en/manual",
	"build-api-zh": "gitbook serve zh/api",
	"build-manual-zh": "gitbook serve zh/manual",
	"build-api-en": "gitbook serve en/api",
	"build-manual-en": "gitbook serve en/manual"
}

qiciengine-documentation's People

Contributors

huhudage avatar yaxixi avatar linyiwei avatar kylin-chen avatar armoonqici avatar morabaraba avatar wylzz0e0 avatar jzaicn avatar

Watchers

James Cloos 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.