This repository contains Docusaurus 2 source and configuration files for generating the static website for the public documentation of the open-source Zui project.
All content for the documentation is stored in markdown files
in the docs directory
of the
Zui repository.
To setup the Docusaurus environment, clone this repo, cd into it, and run:
$ yarn
To edit or author new documentation, it's easiest to clone the Zui repository
into the same top-level directory as this repo and simply run make dev
in this repo. This will create a symlink from called docs in
this directory that points to ../zui/docs, launches the local docusaurus
server, and directs your browser to this server.
You can ctrl-C the make dev process to stop the server.
Any edits you make to files in ../zui/docs will be immediatedly re-rendered by the docusaurus server.
If you don't have a clone of the Zui repo in .., you can pull the
Zui repo docs directory into the ./docs subdirectory by running:
make fetch-latestThen you can run the docusaurus server with:
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.