atuin/docs
Ellie Huxtable 73bd8015c3
Automatically filter out secrets ()
I'd like to extend the regex list here very soon, but start off by
automatically filtering out secrets. Do not store them in history!

I've included regex for:

1. AWS key id
2. Github pat (old and new)
3. Slack oauth tokens (bot, user)
4. Slack webhooks
5. Stripe live/test keys

Will need updating after 
2023-08-19 12:28:39 +01:00
..
blog Add OG image () 2023-07-11 12:28:48 +01:00
docs Automatically filter out secrets () 2023-08-19 12:28:39 +01:00
ru fix: many wins were broken 📝 () 2023-03-19 10:51:05 +00:00
src Tidy up docs () 2023-07-26 09:47:45 +01:00
static Tidy up docs () 2023-07-26 09:47:45 +01:00
zh-CN Move all references to the old repo () 2023-07-30 23:08:00 +01:00
.gitignore Add fancy web docs () 2023-02-25 23:29:59 +00:00
babel.config.js Add fancy web docs () 2023-02-25 23:29:59 +00:00
docusaurus.config.js Move all references to the old repo () 2023-07-30 23:08:00 +01:00
package-lock.json Bump semver from 5.7.1 to 5.7.2 in /docs () 2023-07-14 19:59:47 +01:00
package.json Add fancy web docs () 2023-02-25 23:29:59 +00:00
README.md Add fancy web docs () 2023-02-25 23:29:59 +00:00
sidebars.js Add fancy web docs () 2023-02-25 23:29:59 +00:00
yarn.lock Bump semver from 5.7.1 to 5.7.2 in /docs () 2023-07-14 19:59:47 +01:00

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.