History

amentis ab1e025a75 adding docs for plans and descriptions (not finished)		2024-05-09 18:09:36 +03:00
..
docs	adding docs for plans and descriptions (not finished)	2024-05-09 18:09:36 +03:00
src	Adding docs for field types and semantics, site name fix	2024-04-29 14:30:56 +03:00
static	added docs project	2024-04-18 13:08:56 +03:00
.gitignore	added docs project	2024-04-18 13:08:56 +03:00
README.md	added docs project	2024-04-18 13:08:56 +03:00
babel.config.js	added docs project	2024-04-18 13:08:56 +03:00
docusaurus.config.ts	Adding docs for field types and semantics, site name fix	2024-04-29 14:30:56 +03:00
package-lock.json	Revert "fix languages"	2024-04-19 17:22:56 +03:00
package.json	added docs project	2024-04-18 13:08:56 +03:00
sidebars.ts	Adding docs full structure and all pages, keeping built-in docusaurus tutorials temporarily (on separate category)	2024-04-18 16:57:12 +03:00
tsconfig.json	added docs project	2024-04-18 13:08:56 +03:00

Website

This website is built using Docusaurus, a modern static website generator.

$ yarn

$ 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.

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.