extern/atuin
1
0
Fork 0
mirror of https://github.com/atuinsh/atuin.git synced 2024-11-08 17:35:12 +01:00
Code Issues Packages Projects Releases Wiki Activity
7ed0df49d6
atuin/docs
History
Ellie Huxtable 7ed0df49d6 Fix website build
2023-02-25 23:34:14 +00:00
..
blog Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
docs Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
ru docs: Remove human short flag from docs, duplicate of help -h (#663) 2023-01-11 21:36:51 +00:00
src Fix website build 2023-02-25 23:34:14 +00:00
static Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
zh-CN docs: Fix typo in zh-CN/README.md (#666) 2023-01-15 15:39:40 +00: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 Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
package-lock.json Add fancy web docs (#725) 2023-02-25 23:29:59 +00: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 Add fancy web docs (#725) 2023-02-25 23:29:59 +00: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.