myriation/atuin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
atuin/docs
History
Steve Kemp fab5412e84
Correct typos in website (#946) 
This commit fixes the spelling of "variables" in a couple of places.
2023-05-07 08:15:22 +00:00
..
blog Release v14.0.1 (#883) 2023-04-16 11:25:48 +00:00
docs Correct typos in website (#946) 2023-05-07 08:15:22 +00:00
ru fix: many wins were broken 📝 (#789) 2023-03-19 10:51:05 +00:00
src Make the homepage prettier (#880) 2023-04-15 22:38:23 +01:00
static Make the homepage prettier (#880) 2023-04-15 22:38:23 +01:00
zh-CN docs: fix "From source" cd command (#937) 2023-05-06 14:35:24 +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.