mirror of https://github.com/atuinsh/atuin.git synced 2024-12-29 10:29:55 +01:00

* Add initial site

* WIP again

* Replace docs with web docs

* Bring back translations

* Update README.md

* remove images

2023-02-25 23:29:59 +00: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.