sedum
| Crates.io | sedum |
| lib.rs | sedum |
| version | 0.2.58 |
| created_at | 2021-11-01 22:33:14.457532+00 |
| updated_at | 2023-01-29 19:58:40.776365+00 |
| description | Sedum is a static website generator. |
| homepage | https://github.com/ellygaytor/Sedum |
| repository | https://github.com/ellygaytor/Sedum |
| max_upload_size | |
| id | 475458 |
| size | 52,985 |
Dani (ellygaytor)
documentation
README
Sedum is a static site generator written in Rust. It can be used locally or with a service like Netlify to generate websites on the fly.
Usage
Local
Prerequisites
You must have rust and cargo installed and available on the path.
Setup
- Run
git clone https://github.com/ellygaytor/Sedum.git - Prepend the appropriate yaml to your markdown files (prepending and appending
---) (optional): -title-description-language-author-list('True' or 'False')
Generation
- Run
cargo run [source] [result], setting the source directory and the directory you want the generated files to be placed in.
Netlify
File Based
- Add
netlify.tomlto your git repository - Change the build command and publish directory to fit your needs (optional)
- Prepend the appropriate yaml to your markdown files (prepending and appending ---) (optional)
Manual
Setup
- Set your build command to
wget -N https://github.com/ellygaytor/Sedum/releases/latest/download/sedum && chmod +x sedum && ./sedum [source] [result], setting the source directory and the directory you want the generated files to be placed in. - Set your publish directory to
[result]that you chose in step one. - Prepend the appropriate yaml to your markdown files (prepending and appending
---) (optional): -title-description-language-author-list('True' or 'False')
Generation
- Place your markdown files in
[source]that you set in step one of setup - Push the changes, and Netlify will automatically download the latest version of Sedum, and generate the files.
Options:
| Option | Usage | Description |
|---|---|---|
-t or —timestamp |
… -t … |
Add a timestamp (in seconds since epoch) in a comment to the generated HTML |
-m or -metadata |
… -m … |
Generate a metadata file in the target directory that specifies the time at generation, operating system, and version of Sedum |
Dynamic Replace:
| Usage | Description |
|---|---|
|LIST| |
Insert a HTML list of files with list enabled |
|TIMESTAMP| |
Insert the number of seconds since the epoch |
|COPYRIGHT| |
Insert a copyright notice for the author of the page or the default author in settings. |
Settings File:
The settings file is placed in the source directory, and uses YAML.
| Usage | Description |
|---|---|
default_author |
The default author to be used if not set in the page options |