jasonyan2015/oasis-engine.github.io

This is the documentation of Oasis Engine. Guides, APIs, demos, everything about documentation is included here.

Oasis Engine Site

The documentation source of Oasis Engine.

Development

Steps

1. Clone the engine repository to local (if you have done, please skip to next step):

git clone [email protected]:oasis-engine/engine.git
cd engine
npm i
npm run b:types

2. cd to this site repository, modify the typedocSource field value in siteconfig.json file:

  "typedocSource": "{ENGINE_REPOSITORY_PATH}",

Then run:

$ npm install
$ npm run bootstrap
$ npm run dev

OK, visit http://localhost:8000 .

How to insert a playground in markdown

// leave a blank line here
<playground src="buffer-mesh-instance.ts"></playground>

Deploy

1. Build the public content:

$ npm run build

2. Copy the files in public directory to the root of gh-pages branch.

Playground

How to development

npm run playground

How to link

• Mac

npm link ../engine/packages/* --no-package-lock

• windows

npm link ..\engine\packages\oasis-engine --no-package-lock