doc: update readme
This commit is contained in:
parent
00c737a7f0
commit
d4a49b1749
3 changed files with 22 additions and 0 deletions
22
README.md
22
README.md
|
@ -11,3 +11,25 @@ This page is built with [vitepress](https://vitepress.dev/). The theme is fully
|
||||||
The font used is [VT323 by Peter Hull](https://github.com/phoikoi/VT323/), which can be installed via [fontsource](https://fontsource.org/fonts/vt323) as a node package.
|
The font used is [VT323 by Peter Hull](https://github.com/phoikoi/VT323/), which can be installed via [fontsource](https://fontsource.org/fonts/vt323) as a node package.
|
||||||
|
|
||||||
The ascii art headers are generated with `figlet`, using the [Chunky](https://github.com/xero/figlet-fonts/blob/master/Chunky.flf) font.
|
The ascii art headers are generated with `figlet`, using the [Chunky](https://github.com/xero/figlet-fonts/blob/master/Chunky.flf) font.
|
||||||
|
|
||||||
|
![k0r.386 screenshot with highlighted features](https://git.k0r.in/n/k0r.386/raw/branch/main/features.jpg)
|
||||||
|
|
||||||
|
k0r.386 offers some old-school goodness, paired with modern features where convenience matters.
|
||||||
|
|
||||||
|
Notable features are:
|
||||||
|
|
||||||
|
* ASCII Art Titles, auto generated by Figlet.js
|
||||||
|
* Automatic page discovery
|
||||||
|
* Footer with clickable links, that can be set up per command (for example an "about" command could add an email link) or per page (configurable in frontmatter)
|
||||||
|
* Interactive prompt, for the old-school terminal feeling
|
||||||
|
|
||||||
|
Planned features are:
|
||||||
|
|
||||||
|
* Pagination (`more`-style)
|
||||||
|
|
||||||
|
Anti-features (what you will not find as part of this theme):
|
||||||
|
|
||||||
|
* Text formatting
|
||||||
|
* Syntax highlighting
|
||||||
|
* a real interactive shell with editor and an ascii art aquarium (...or maybe?)
|
||||||
|
|
||||||
|
|
BIN
features.jpg
Normal file
BIN
features.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 176 KiB |
BIN
screenshot.jpg
BIN
screenshot.jpg
Binary file not shown.
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 123 KiB |
Loading…
Reference in a new issue