mirror of
https://github.com/atuinsh/atuin.git
synced 2024-11-29 11:44:44 +01:00
7cc893d67d
* Added Shortcuts section to keybinings * Removed obvious shortcuts * Update docs/docs/config/key-binding.md Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com> * Update docs/docs/config/key-binding.md Co-authored-by: Conrad Ludgate <oon@conradludgate.com> * replaced cursor keys with emojis * got back to utf symbols --------- Co-authored-by: Ellie Huxtable <ellie@elliehuxtable.com> Co-authored-by: Conrad Ludgate <oon@conradludgate.com> |
||
---|---|---|
.. | ||
blog | ||
docs | ||
ru | ||
src | ||
static | ||
zh-CN | ||
.gitignore | ||
babel.config.js | ||
docusaurus.config.js | ||
package-lock.json | ||
package.json | ||
README.md | ||
sidebars.js | ||
yarn.lock |
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
$ yarn
Local Development
$ 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.
Build
$ yarn build
This command generates static content into the build
directory and can be served using any static contents hosting service.
Deployment
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.