Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/barelyhuman/mudkip

The non-customizable markdown to html CLI (another documentation generator)
https://github.com/barelyhuman/mudkip

generator html markdown static-site

Last synced: about 1 month ago
JSON representation

The non-customizable markdown to html CLI (another documentation generator)

Host: GitHub
URL: https://github.com/barelyhuman/mudkip
Owner: barelyhuman
License: mit
Created: 2022-04-24T20:16:12.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-08-20T14:35:16.000Z (3 months ago)
Last Synced: 2024-10-02T08:44:55.863Z (about 1 month ago)
Topics: generator, html, markdown, static-site
Language: Nim
Homepage: https://barelyhuman.github.io/mudkip
Size: 168 KB
Stars: 6
Watchers: 3
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

README

The non-customizable markdown to html generator

## Highlights

- Tightly scoped
- Multi Threaded
- Atomic File Processor
- Small (1.1 MB)
- File Watcher (Monitor file changes)
- (Optional) Client sided search, if JS is enabled

## Things missing

- File Server (bring your own) (or I'll add it at some point)

## Installation

### Prebuilt Binaries

You can download the binaries from
[Releases →](https://github.com/barelyhuman/mudkip/releases)

### Curl for the Prebuilt Binaries

On unix(including macOS)/linux environments you can just use the below commands to download and install the binary

```
curl -o mudkip.tgz -L https://github.com/barelyhuman/mudkip/releases/latest/download/-.tgz

tar -xvzf mudkip.tgz

install -/mudkip /usr/local/bin
```

Replace `` and `` with the available values from the releases page

### Compile from source

You can also compile from source
**prerequisites** make sure you have [nim lang](https://nim-lang.org) installed and running on your system.

Then

1. Clone and build

```sh
git clone https://github.com/barelyhuman/mudkip
cd mudkip
nimble install
nimble build -d:release
```

2. Copy the binary to a folder that's available on your system `PATH` variable

## Documentation

You can read it on the [website](https://barelyhuman.github.io/mudkip) (which, mudkip generated)
or if locally cloned, go through the `docs` folders

## License