Compare commits
5 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 30b7681234 | |||
| 13b6106efd | |||
| 831b081fc7 | |||
| fde423a32b | |||
| 55a82f75a9 |
18
README.md
18
README.md
@@ -10,22 +10,12 @@
|
|||||||
_kewt_ is a minimalist ssg inspired by _[werc](http://werc.cat-v.org/)_ and _[kew](https://github.com/uint23/kew)_
|
_kewt_ is a minimalist ssg inspired by _[werc](http://werc.cat-v.org/)_ and _[kew](https://github.com/uint23/kew)_
|
||||||
|
|
||||||
|
|
||||||
## Quick Install
|
## [Installation](https://kewt.krzak.org/#Installation)
|
||||||
|
|
||||||
```sh
|
|
||||||
curl -L -o kewt https://git.krzak.org/N0VA/kewt/releases/download/latest/kewt
|
|
||||||
chmod +x kewt
|
|
||||||
```
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Either through a pull request to the **home** repository ([N0VA/kewt](https://git.krzak.org/N0VA/kewt)) or by sending a patch to my email address ([n0va@krzak.org](mailto:n0va@krzak.org))
|
Either open an issue or pull request on the **home** repository ([N0VA/kewt](https://git.krzak.org/N0VA/kewt)) or message me on my email address ([n0va@krzak.org](mailto:n0va@krzak.org?subject=%5Bkewt%5D%20something)) with the subjectline being `[kewt] something`.
|
||||||
|
|
||||||
## Credits
|
## License
|
||||||
|
|
||||||
- _kew_ css style adapted from _[kew](https://github.com/uint23/kew)_ by [uint23](https://github.com/uint23)
|
ISC
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
class Kewt < Formula
|
class Kewt < Formula
|
||||||
desc "Minimalist static site generator inspired by werc"
|
desc "Minimalist static site generator inspired by werc"
|
||||||
homepage "https://kewt.krzak.org"
|
homepage "https://kewt.krzak.org"
|
||||||
url "https://github.com/n0va-bot/kewt/releases/download/VERSION_PLACEHOLDER/kewt"
|
url "https://github.com/n0va-bot/kewt/releases/download/vVERSION_PLACEHOLDER/kewt"
|
||||||
sha256 "SHA256SUM_PLACEHOLDER"
|
sha256 "SHA256SUM_PLACEHOLDER"
|
||||||
license "ISC"
|
license "ISC"
|
||||||
version "VERSION_PLACEHOLDER"
|
version "VERSION_PLACEHOLDER"
|
||||||
|
|||||||
@@ -31,20 +31,58 @@ It's meant to be a static site generator, like _[kew](https://github.com/uint23/
|
|||||||
|
|
||||||
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 `\![]`
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
## Installation
|
## 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:
|
### Standalone
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
curl -L -o kewt https://git.krzak.org/N0VA/kewt/releases/download/latest/kewt
|
curl -L -o kewt https://git.krzak.org/N0VA/kewt/releases/download/latest/kewt
|
||||||
chmod +x kewt
|
chmod +x kewt
|
||||||
```
|
```
|
||||||
|
|
||||||
On Arch Linux, _kewt_ is available on the AUR:
|
### From source
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone https://git.krzak.org/N0VA/kewt.git
|
||||||
|
cd kewt
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Building
|
||||||
|
|
||||||
|
```sh
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Installing
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sudo make install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Package Managers
|
||||||
|
|
||||||
|
#### AUR
|
||||||
|
|
||||||
- [kewt-bin](https://aur.archlinux.org/packages/kewt-bin) — prebuilt standalone binary from the latest release
|
- [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
|
- [kewt-git](https://aur.archlinux.org/packages/kewt-git) — built from the latest git source
|
||||||
|
|
||||||
|
#### Homebrew
|
||||||
|
|
||||||
|
```sh
|
||||||
|
brew tap n0va-bot/tap
|
||||||
|
brew install kewt
|
||||||
|
```
|
||||||
|
|
||||||
|
#### bpkg
|
||||||
|
|
||||||
|
```sh
|
||||||
|
bpkg install n0va-bot/kewt
|
||||||
|
```
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
@@ -60,7 +98,7 @@ On Arch Linux, _kewt_ is available on the AUR:
|
|||||||
|
|
||||||
`--post` creates a new empty markdown file in the configured `posts_dir` with the current date and time as the name.
|
`--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
|
||||||
title = "kewt"
|
title = "kewt"
|
||||||
@@ -116,13 +154,13 @@ custom_admonitions = ""
|
|||||||
- `enable_header_links` turns markdown section headings into clickable anchor links (default: true)
|
- `enable_header_links` turns markdown section headings into clickable anchor links (default: true)
|
||||||
- `custom_admonitions` comma separated list of custom admonitions
|
- `custom_admonitions` comma separated list of custom admonitions
|
||||||
|
|
||||||
## Ignores
|
### Ignores
|
||||||
|
|
||||||
- `.kewtignore`: Files/directories to ignore. If empty, the whole directory gets ignored
|
- `.kewtignore`: Files/directories to ignore. If empty, the whole directory gets ignored
|
||||||
- `.kewthide`: Files/directories to hide from navigation but still process. Same empty rules as with ignore
|
- `.kewthide`: Files/directories to hide from navigation but still process. Same empty rules as with ignore
|
||||||
- `.kewtpreserve`: Files/directories to copy but not convert markdown to html. Same empty rules again
|
- `.kewtpreserve`: Files/directories to copy but not convert markdown to html. Same empty rules again
|
||||||
|
|
||||||
## Embeds
|
### Embeds
|
||||||
|
|
||||||
- `\![link]`:
|
- `\![link]`:
|
||||||
- local image/audio/video files are embedded as media tags
|
- local image/audio/video files are embedded as media tags
|
||||||
@@ -132,9 +170,7 @@ custom_admonitions = ""
|
|||||||
- `\` works the same, with `alt` used for images
|
- `\` works the same, with `alt` used for images
|
||||||
- `\!![]` and `\!` force inline local file contents
|
- `\!![]` and `\!` force inline local file contents
|
||||||
|
|
||||||
## Credits
|
***
|
||||||
|
|
||||||
- _kew_ css style adapted from _[kew](https://github.com/uint23/kew)_ by [uint23](https://github.com/uint23)
|
|
||||||
|
|
||||||
>[!WARNING]
|
>[!WARNING]
|
||||||
>The base that all of this is built upon was coded at night, while sleepy and a bit sick, and after walking for about 4 hours around a forest, so...
|
>The base that all of this is built upon was coded at night, while sleepy and a bit sick, and after walking for about 4 hours around a forest, so...
|
||||||
|
|||||||
Reference in New Issue
Block a user