sfeuga/kewt
1
0
Fork 0
forked from N0VA/kewt
Code Pull Requests Activity

fix: navbar draft

Browse Source
This commit is contained in:
N0\A
2026-05-05 20:39:55 +02:00
parent b8e6c3afa8
commit c8df9a3da9
8 changed files with 67 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
site/docs/configuration.md
View File

@@ -62,7 +62,7 @@ include_cw_pages_in_search = false
- `favicon` - explicit favicon path (used when `logo_as_favicon` is false or no logo is set)
- `generate_page_title` - automatically generate title text from the first markdown heading or filename (default: true)
- `error_page` - filename for the generated 404 error page (default: "not_found.html", empty to disable)
- `versioning` - append a version query parameter (`?v=timestamp`) to css asset urls to bypass cache (default: false)
- `versioning` - append a build-time version query parameter (for example `?v=20260505193210`) to css asset urls to bypass cache (default: false)
- `enable_header_links` - turns markdown section headings into clickable anchor links (default: true)
- `base_url` - absolute URL of the site, used for sitemap and RSS feed generation
- `generate_feed` - enable RSS feed generation (requires `base_url`)
@@ -75,7 +75,7 @@ include_cw_pages_in_search = false
- `tags_dir` - directory name for generated tag pages (default: "tags")
- `generate_search` - generate a `search.json` index for client-side search
- `search_in_footer` - include a search box in the page footer (requires `generate_search`)
- `search_in_header` - include a search box in the page header (requires `generate_search`)
- `search_in_header` - include a search box in the page header (requires `generate_search` and a template that includes `{{HEADER_SEARCH}}`)
- `include_cw_pages_in_search` - include content warning pages in the search index (default: false)
## Dot Files

2
site/docs/markdown.md
View File

@@ -38,7 +38,7 @@ This renders as `<dl><dt>Term</dt><dd>Definition</dd></dl>`. Multiple definition
## Emoji Shortcodes
Standard GitHub/MkDocs emoji shortcodes like `:smile:`, `:fire:`, `:rocket:` are automatically replaced with their Unicode emoji equivalents. Shortcodes inside code blocks are left as-is.
Standard GitHub/MkDocs emoji shortcodes like `:smile:`, `:fire:`, `:rocket:` are automatically replaced with their Unicode emoji equivalents. Shortcodes inside codeblocks are left as-is.
## Pipe Tables

3
site/docs/templates.md
View File

@@ -13,7 +13,10 @@ When customizing `template.html`, the placeholders available are:
- `{{LANG}}` - the configured document language
- `{{HEAD_EXTRA}}` - meta-tags
- `{{HEADER_BRAND}}` - header rendering the name and/or logo
- `{{HEADER_SEARCH}}` - header search form when `search_in_header = true`
## Search
When `generate_search` is enabled, kewt embeds a search bar into pages based on the `search_in_header` and `search_in_footer` config options. The search uses a `search.json` index generated at build time and a client-side JS script. No external dependencies are required.
If you use a custom template and want header search enabled, make sure your `template.html` includes `{{HEADER_SEARCH}}` somewhere inside `<header>`.

2
site/docs/usage.md
View File

@@ -22,4 +22,4 @@ kewt --serve [port]
- `--watch` (`-w`) watches for file changes in the source directory and rebuilds automatically.
- `--clean` cleans the output directory before building (default behavior).
- `--no-clean` does not clean the output directory before building. Useful with `--watch` to avoid clearing output on every rebuild.
- `--serve` (`-s`) starts a local HTTP server (python3 or busybox) in the output directory after building. Use with the port number to specify the port. Composable with `--watch`.
- `--serve` (`-s`) starts a local HTTP server (python3 or busybox) in the output directory after building. Use with the port number to specify the port. The default port is `8000`. Composable with `--watch`.