N0VA/kewt
1
1
Fork 0
Code Issues Pull Requests Actions Releases 13 Activity

docs: new features
All checks were successful
Lint / shellcheck (push) Successful in 18s
Details

Browse Source
This commit is contained in:
N0\A
2026-03-17 12:56:15 +01:00
parent 19f96553d9
commit 8b1e793510
2 changed files with 27 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -16,6 +16,8 @@ It's meant to be a static site generator, like _[kew](https://github.com/uint23/
- Inline html support - Inline html support
- MFM `$font` and `\<plain>` tags - MFM `$font` and `\<plain>` tags
- Admonition support (that's what the blocks like the warning block below are called) - Admonition support (that's what the blocks like the warning block below are called)
- RSS/Feed generation and Sitemap support
- Post creation via `--post`
If you want to **force** a file to be inlined, use `\!![]` instead of `\![]` If you want to **force** a file to be inlined, use `\!![]` instead of `\![]`
@@ -38,12 +40,15 @@ On Arch Linux, _kewt_ is available on the AUR:
```sh ```sh
./kewt.sh --help ./kewt.sh --help
./kewt.sh --new [title] ./kewt.sh --new [title]
./kewt.sh --post
./kewt.sh --from <src> --to <out> ./kewt.sh --from <src> --to <out>
./kewt.sh [src] [out] ./kewt.sh [src] [out]
``` ```
`--new [title]` creates a new site directory with a copied `site.conf` and a default `index.md`. `--new [title]` creates a new site directory with a copied `site.conf` and a default `index.md`.
`--post` creates a new empty markdown file in the configured `posts_dir` with the current date and time as the name.
## site.conf ## site.conf
```conf ```conf
@@ -66,6 +71,10 @@ favicon = ""
generate_page_title = true generate_page_title = true
error_page = "not_found.html" error_page = "not_found.html"
versioning = false versioning = false
base_url = ""
generate_feed = false
feed_file = "rss.xml"
posts_dir = ""
``` ```
- `title` site title - `title` site title
@@ -87,6 +96,10 @@ versioning = false
- `generate_page_title` automatically generate title text from the first markdown heading or filename (default: true) - `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) - `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 version query parameter (`?v=timestamp`) to css asset urls to bypass cache (default: false)
- `base_url` absolute URL of the site, used for sitemap and RSS feed generation
- `generate_feed` enable RSS feed generation (requires `base_url`)
- `feed_file` filename for the generated RSS feed (default: "rss.xml")
- `posts_dir` directory name containing posts (e.g., "posts"). Enables reverse-chronological sorting, title headings in indexes, and automatic backlinks.
## Ignores ## Ignores

15
site/index.md
View File

@@ -16,6 +16,8 @@ It's meant to be a static site generator, like _[kew](https://github.com/uint23/
- Inline html support - Inline html support
- MFM `$font` and `\<plain>` tags - MFM `$font` and `\<plain>` tags
- Admonition support (that's what the blocks like the warning block below are called) - Admonition support (that's what the blocks like the warning block below are called)
- RSS/Feed generation and Sitemap support
- Post creation via `--post`
If you want to **force** a file to be inlined, use `\!![]` instead of `\![]` If you want to **force** a file to be inlined, use `\!![]` instead of `\![]`
@@ -38,12 +40,15 @@ On Arch Linux, _kewt_ is available on the AUR:
```sh ```sh
./kewt.sh --help ./kewt.sh --help
./kewt.sh --new [title] ./kewt.sh --new [title]
./kewt.sh --post
./kewt.sh --from <src> --to <out> ./kewt.sh --from <src> --to <out>
./kewt.sh [src] [out] ./kewt.sh [src] [out]
``` ```
`--new [title]` creates a new site directory with a copied `site.conf` and a default `index.md`. `--new [title]` creates a new site directory with a copied `site.conf` and a default `index.md`.
`--post` creates a new empty markdown file in the configured `posts_dir` with the current date and time as the name.
## site.conf ## site.conf
```conf ```conf
@@ -66,6 +71,10 @@ favicon = ""
generate_page_title = true generate_page_title = true
error_page = "not_found.html" error_page = "not_found.html"
versioning = false versioning = false
base_url = ""
generate_feed = false
feed_file = "rss.xml"
posts_dir = ""
``` ```
- `title` site title - `title` site title
@@ -87,6 +96,10 @@ versioning = false
- `generate_page_title` automatically generate title text from the first markdown heading or filename (default: true) - `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) - `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 version query parameter (`?v=timestamp`) to css asset urls to bypass cache (default: false)
- `base_url` absolute URL of the site, used for sitemap and RSS feed generation
- `generate_feed` enable RSS feed generation (requires `base_url`)
- `feed_file` filename for the generated RSS feed (default: "rss.xml")
- `posts_dir` directory name containing posts (e.g., "posts"). Enables reverse-chronological sorting, title headings in indexes, and automatic backlinks.
## Ignores ## Ignores
@@ -108,5 +121,5 @@ versioning = false
- Default css style and html template based on _[kew](https://github.com/uint23/kew)_ by [uint23](https://github.com/uint23) - Default css style and html template based on _[kew](https://github.com/uint23/kew)_ by [uint23](https://github.com/uint23)
>![WARNING] >[!WARNING]
>Most of this was coded at night, while sleepy and a bit sick, and after walking for about 4 hours around a forest, so... >Most of this was coded at night, while sleepy and a bit sick, and after walking for about 4 hours around a forest, so...