extern/atuin
1
0
Fork 0
mirror of https://github.com/atuinsh/atuin.git synced 2024-12-27 01:19:45 +01:00
Code Issues Packages Projects Releases Wiki Activity
340b9d8a2b
atuin/docs
History
Ellie Huxtable 340b9d8a2b
Update shell-completions.md
2023-08-30 22:25:02 +01:00
..
blog Add OG image (#1097) 2023-07-11 12:28:48 +01:00
docs Update shell-completions.md 2023-08-30 22:25:02 +01:00
ru fix: many wins were broken 📝 (#789) 2023-03-19 10:51:05 +00:00
src Tidy up docs (#1120) 2023-07-26 09:47:45 +01:00
static Tidy up docs (#1120) 2023-07-26 09:47:45 +01:00
zh-CN Move all references to the old repo (#1132) 2023-07-30 23:08:00 +01:00
.gitignore Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
babel.config.js Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
docusaurus.config.js Move all references to the old repo (#1132) 2023-07-30 23:08:00 +01:00
package-lock.json Bump semver from 5.7.1 to 5.7.2 in /docs (#1100) 2023-07-14 19:59:47 +01:00
package.json Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
README.md Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
sidebars.js Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
yarn.lock Bump semver from 5.7.1 to 5.7.2 in /docs (#1100) 2023-07-14 19:59:47 +01:00

README.md

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.