Skip to content

Commit ccf7c5d

Browse files
committed
update readme
1 parent 0fc4e5b commit ccf7c5d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Lite XL Website
22

3-
> **Note**
4-
> This website is still under construction.
5-
> Expect jank and general problems.
6-
73
This website is written in Markdown with [MkDocs] and [mkdocs-material].
84
We also use [mkdocs-macros-plugin] for rendering certain pages.
95

@@ -87,11 +83,15 @@ This project follows typical [MkDocs] file structure.
8783
- `extra.css`: Styles for custom syntax highlighting.
8884
- `user-guide/`
8985
- `index.md`: Homepage.
86+
- `overrides/`: Overrides for the theme
9087

9188
# Keymap
9289

9390
The "generate keymap" action should be run after each release to update
9491
the keymap.
92+
This workflow should run automatically, provided that the API keys used
93+
to invoke this workflow is still valid.
94+
9595
The keymap generation is currently a two-part process involving some
9696
fix up on our side to match [pymdown]'s syntax.
9797
This can be found in `fix-keymap.py`.
@@ -104,4 +104,4 @@ This can be found in `fix-keymap.py`.
104104
[pub-minifier]: https://mkdocs-publisher.github.io/setup/seo-and-sharing/pub-minifier/
105105
[GTK Runtime]: https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer
106106
[uv]: https://docs.astral.sh/uv/
107-
[pymdown]: https://facelessuser.github.io/pymdown-extensions/extensions/keys
107+
[pymdown]: https://facelessuser.github.io/pymdown-extensions/extensions/keys

0 commit comments

Comments
 (0)