mirror of https://github.com/cursorless-dev/cursorless.git synced 2024-10-05 05:17:38 +03:00

History

Pokey Rule 471e07415c Move netlify.toml (#865 )		2022-07-13 17:31:55 +02:00
..
src/css	Minor Cursorless docs follow-up tweaks (#610 )	2022-03-18 10:58:00 +00:00
static	Serve docs folder and API reference on GitHub pages (#477 )	2022-03-16 23:23:03 +00:00
.gitignore	Serve docs folder and API reference on GitHub pages (#477 )	2022-03-16 23:23:03 +00:00
babel.config.js	Run pre-commit	2022-04-25 11:21:26 +01:00
docusaurus.config.js	docusaurus.config.js: Remove trailing slash on url (#680 )	2022-05-20 11:25:04 +01:00
package.json	Switch to netlify (#856 )	2022-07-12 16:54:21 +01:00
README.md	Serve docs folder and API reference on GitHub pages (#477 )	2022-03-16 23:23:03 +00:00
sidebar.js	Run pre-commit	2022-04-25 11:21:26 +01:00
typedoc.js	Run pre-commit	2022-04-25 11:21:26 +01:00
yarn.lock	Switch to netlify (#856 )	2022-07-12 16:54:21 +01:00

Website

This website is built using Docusaurus 2, 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.