Skip to content

Latest commit

 

History

History
19 lines (10 loc) · 1.02 KB

README.md

File metadata and controls

19 lines (10 loc) · 1.02 KB

Qi Design Standard

This is the documentation of Qi Design Standard. It contains the design standard explanation, the components library design specification, the development schedule, and other descriptions.

For more details about this standard, please visit the website: https://qiqi-1996.github.io/qi-design-standard

For more details about this repository, please read as follow:

Development Environment

I use Docute to host the documentation website for now, and it is very convenience because:

it is totally runtime-driven so there are no server-side components involved which also means there's no build process.

But I still create some scripts to let documentation compose more convenience, use npm install to get the environment ready.

Auto Reload

After the environment got ready, use npm start to start it up and visit the URL come out of the console. And every time you modify the files inner the docs directory will make the browser auto-reload, so you can see the changes immediately.