nixite/README.md
2024-01-01 17:31:17 +00:00

58 lines
937 B
Markdown

# Nixite
A static site generator made in Nix.
This is currently very experimental / subject to change.
## Why
Clearly there aren't already enough web frameworks out there.
I thought it would be fun.
I wanted to get better at Nix.
Importing other people's styles / component libs could actually be a decent experience.
You can process your site with the power of nixpkgs - eg you could process images using imagemagick.
## How
Read `flake.nix` for basic usage.
The default package will serve the site locally (using caddy)
```sh
nix run .
```
Or you can build it raw:
```sh
nix build .#raw
```
## features
- [X] file paths
- [X] global styles
- [X] custom components with styles
- [X] component extend / inheritance
### markdown
- [ ] frontmatter
- [X] headers
- [X] paragraphs
- [ ] tables
- [X] lists
- [ ] checkboxes
- [ ] images
- [ ] links
- [X] codeblocks
- [ ] subscript
- [X] highlight
- [X] italics
- [X] bold