Nicoletta-Crystal/README.md

31 lines
1.0 KiB
Markdown
Raw Normal View History

2023-05-31 23:18:05 +00:00
# nicoletta
2023-06-01 01:13:44 +00:00
[Nicoletta](https://github.com/ralsina/nicoletta) is a very (very) minimalistic static site generator I wrote using Python. This repo contains a reimplementation using the [Crystal language](https://crystal-lang.org/) I did in order to learn the language.
2023-05-31 23:18:05 +00:00
2023-06-01 01:13:44 +00:00
I actually wrote down a [journal](journal.md) while doing it, too!
2023-05-31 23:18:05 +00:00
2023-06-01 01:13:44 +00:00
## Build and Install
You can build it by running `shards build` and install it by copying `bin/nicoletta` somewhere in yout PATH. Why would you do that, I have no idea.
2023-05-31 23:18:05 +00:00
## Usage
2023-06-01 01:13:44 +00:00
Running `nicoletta` will:
* Read a `conf` file, which should be YAML
* Read markdown files from `posts/` which have YAML metadata on top
* Use the template `templates/post.tmpl` to turn the markdown into a HTML fragment using the post's metadata
2023-06-01 01:24:23 +00:00
* Use the template `templates/page.tmpl` to turn that fragment into a HTML page using the site's config
2023-05-31 23:18:05 +00:00
2023-06-01 01:13:44 +00:00
This repo contains examples for everything :-)
2023-05-31 23:18:05 +00:00
## Development
2023-06-01 01:13:44 +00:00
Let's not :-)
2023-05-31 23:18:05 +00:00
## Contributing
2023-06-01 01:13:44 +00:00
Why????
2023-05-31 23:18:05 +00:00
## Contributors
2023-06-01 01:13:44 +00:00
- [Roberto Alsina](https://ralsina.me) - creator and maintainer