diff --git a/README.md b/README.md index e663f9a..8a82237 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,16 @@ # _kewt_ ### Pronounced "cute" +*** + # [Go to the website](https://kewt.krzak.org) +*** + _kewt_ is a minimalist ssg inspired by _[werc](http://werc.cat-v.org/)_ and _[kew](https://github.com/uint23/kew)_ -It's meant to be a static site generator, like _[kew](https://github.com/uint23/kew)_ but use only default (POSIX) tooling, like _[werc](http://werc.cat-v.org/)_ (and definitely unlike _[kew](https://github.com/uint23/kew)_) -## Features - -- No dependencies -- Supports many embed types -- Automatic css variable replacement for older browsers -- Automatic inlining and embedding of many filetypes with `\![link]` or `\![alt](link)` -- Inline html support -- MFM `$font` and `\` tags -- 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 `\![]` - -## Installation - -You can clone the repository to use `kewt.sh` directly, or you can download the standalone executable, which bundles all dependencies into a single file: +## Quick Install ```sh curl -L -o kewt https://git.krzak.org/N0VA/kewt/releases/download/latest/kewt @@ -35,91 +22,6 @@ On Arch Linux, _kewt_ is available on the AUR: - [kewt-bin](https://aur.archlinux.org/packages/kewt-bin) — prebuilt standalone binary from the latest release - [kewt-git](https://aur.archlinux.org/packages/kewt-git) — built from the latest git source -## Usage - -```sh -./kewt.sh --help -./kewt.sh --new [title] -./kewt.sh --post -./kewt.sh --from --to -./kewt.sh [src] [out] -``` - -`--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 - -```conf -title = "kewt" -style = "kewt" -dir_indexes = true -single_file_index = true -flatten = false -order = "" -home_name = "Home" -show_home_in_nav = true -nav_links = "" -nav_extra = "" -footer = "made with kewt" -logo = "" -display_logo = false -display_title = true -logo_as_favicon = true -favicon = "" -generate_page_title = true -error_page = "not_found.html" -versioning = false -base_url = "" -generate_feed = false -feed_file = "rss.xml" -posts_dir = "" -``` - -- `title` site title -- `style` style file name from `./styles` (without `.css`) -- `dir_indexes` generate directory index pages when missing `index.md` -- `single_file_index` if a directory has one markdown file and no `index.md`, use that file as `index.html` -- `flatten` flatten sidebar directory levels -- `order` comma separated file/directory name list to order the sidebar (alphabetical by default) -- `home_name` text for the home link in navigation (default: "Home") -- `show_home_in_nav` show home link in navigation (default: true) -- `nav_links` comma separated extra nav links, as bare URLs or Markdown links like `[Label](https://example.com)` -- `nav_extra` raw HTML appended inside the `