-
+
+ 
+
+
+ Doks +
+ ++ Doks Child Theme +
+ ++ Doks is a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.
-magical shell history
+
+ 
+ -
- 
- 
- 
- 
- 
-
-exit code, duration, time and command shown -
+6. __Netlify-ready__. Deploy to Netlify with sensible defaults. Easily use Netlify Functions, Netlify Redirects, and Netlify Headers. +7. __Full text search__. Search your Doks site with FlexSearch. Easily customize index settings and search options to your liking. +8. __Page layouts__. Build pages with a landing page, blog, or documentation layout. Add custom sections and components to suit your needs. +9. __Dark mode__. Switch to a low-light UI with the click of a button. Change colors with variables to match your branding. +### Other features -As well as the search UI, it can do things like this: +- __Multilingual and i18n__ support +- __Versioning__ documentation support +- __KaTeX__ math typesetting +- __Mermaid__ diagrams and visualization +- __highlight.js__ syntax highlighting -``` -# search for all successful `make` commands, recorded after 3pm yesterday -atuin search --exit 0 --after "yesterday 3pm" make +## Requirements + +Doks uses npm to centralize dependency management, making it [easy to update](https://getdoks.org/docs/help/how-to-update/) resources, build tooling, plugins, and build scripts: + +- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. + +## Get started + +Start a new Doks project in three steps: + +### 1. Create a new site + +Doks is available as a child theme, and a starter theme: + +- Use the Doks child theme, if you do __not__ plan to customize a lot, and/or need future Doks updates. +- Use the Doks starter theme, if you plan to customize a lot, and/or do __not__ need future Doks updates. + +Not quite sure? Use the Doks child theme. + +#### Doks child theme + +```bash +git clone https://github.com/h-enk/doks-child-theme.git my-doks-site && cd my-doks-site ``` -You may use either the server I host, or host your own! Or just don't use sync -at all. As all history sync is encrypted, I couldn't access your data even if -I wanted to. And I **really** don't want to. +#### Doks starter theme -## Features +```bash +git clone https://github.com/h-enk/doks.git my-doks-site && cd my-doks-site +``` -- rebind `up` and `ctrl-r` with a full screen history search UI -- store shell history in a sqlite database -- backup and sync **encrypted** shell history -- the same history across terminals, across sessions, and across machines -- log exit code, cwd, hostname, session, command duration, etc -- calculate statistics such as "most used command" -- old history file is not replaced -- quick-jump to previous items with Alt-\
-
-
-神奇的 shell 历史记录 -
- -- -
-
-
-
-
- 
-
-显示退出代码、命令持续时间、上次执行时间和执行的命令 -
- -除了搜索 UI，它还可以执行以下操作： - -``` -# 搜索昨天下午3点之后记录的所有成功的 `make` 命令 -atuin search --exit 0 --after "yesterday 3pm" make -``` - -你可以使用我(ellie)托管的服务器，也可以使用你自己的服务器！或者干脆不使用 sync 功能。所有的历史记录同步都是加密，即使我想，也无法访问你的数据。且我**真的**不想。 - -## 特点 - -- 重新绑定 `up` 和 `ctrl-r` 的全屏历史记录搜索UI界面 -- 使用 sqlite 数据库存储 shell 历史记录 -- 备份以及同步已加密的 shell 历史记录 -- 在不同的终端、不同的会话以及不同的机器上都有相同的历史记录 -- 记录退出代码、cwd、主机名、会话、命令持续时间，等等。 -- 计算统计数据，如 "最常用的命令"。 -- 不替换旧的历史文件 -- 通过 Alt-\
+
+
+
+ 
+ +
+
+
+
+
+
+ 
+
+
+
+
+ Sync
+The same shell history everywhere! Atuin optionally syncs your shell history between all of your machines
+Search
+Atuin supports multiple different types of search, from prefix to fuzzy
+Store
+Log exit code, cwd, hostname, session, command duration, etc
+
+
+
+
+ Key bindings
+-
+
- rebind ctrl-r and up with a full-screen history search UI +
- all bindings are optional and configurable +
Filter modes
+Search shell history globally, from the current session, or current directory
+Fast ⚡️
+Written in Rust, Atuin is faster than you are
+
+ 
+
+
+ +
+
+
+
+
+
+
+
+
+ 
+
+
+
+
+ Use the official atuin.sh sync server and gain access to metrics and analysis
+
+
+
+ {{- .Content -}}
+
+