extern/atuin
1
0
Fork 0
mirror of https://github.com/atuinsh/atuin.git synced 2024-12-28 01:49:33 +01:00
Code Issues Packages Projects Releases Wiki Activity
301296fae5
atuin/docs
History
Brian Kung 301296fae5
Add additional detail to search documentation (#860)
2023-04-11 11:25:02 +01:00
..
blog Clarify in docs 2023-04-01 18:45:19 +01:00
docs Add additional detail to search documentation (#860) 2023-04-11 11:25:02 +01:00
ru fix: many wins were broken 📝 (#789) 2023-03-19 10:51:05 +00:00
src Add hachyderm to home 2023-02-28 22:37:42 +00:00
static Add fancy web docs (#725) 2023-02-25 23:29:59 +00:00
zh-CN Minor documentation updates (#767) 2023-03-08 20:20:39 +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 Hachyderm links (#742) 2023-02-28 22:27:06 +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.