atuin/docs
Ellie Huxtable 88f3e2a04f
Add enter_accept to immediately execute an accepted command (#1311)
* make enter execute the command, tab copy it

* Add config for enter_accept

enter_accept will make Atuin immediately accept an execute a command
when selected. It defaults to false in our binary, but the default
config enables it.

This means that users who already use atuin will not default to the new
behaviour unless they opt in, but new users will have it by default.

Thanks to @davidhewitt for the patch and bulk of this implementation!
Currently we have it just for zsh, but I'll follow up with other shells
(unless anyone beats me to it :D)

* Add docs

* we need to tidy up the ui code anyway

* Check if using zsh

* Update docs/docs/config/config.md

Co-authored-by: Conrad Ludgate <conradludgate@gmail.com>

---------

Co-authored-by: David Hewitt <1939362+davidhewitt@users.noreply.github.com>
Co-authored-by: Conrad Ludgate <conradludgate@gmail.com>
2023-10-20 07:16:54 +01:00
..
blog Add OG image (#1097) 2023-07-11 12:28:48 +01:00
docs Add enter_accept to immediately execute an accepted command (#1311) 2023-10-20 07:16:54 +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 @babel/traverse from 7.21.2 to 7.23.2 in /docs (#1309) 2023-10-17 15:51:24 -07: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 @babel/traverse from 7.21.2 to 7.23.2 in /docs (#1309) 2023-10-17 15:51:24 -07: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.