nixite/README.md

58 lines
937 B
Markdown
Raw Normal View History

2023-12-31 00:33:48 +00:00
# Nixite
A static site generator made in Nix.
This is currently very experimental / subject to change.
2023-12-31 00:33:48 +00:00
## 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.
2024-01-01 00:04:17 +00:00
The default package will serve the site locally (using caddy)
2023-12-31 00:33:48 +00:00
```sh
2024-01-01 00:04:17 +00:00
nix run .
2023-12-31 00:33:48 +00:00
```
2024-01-01 00:04:17 +00:00
Or you can build it raw:
2023-12-31 00:33:48 +00:00
```sh
2024-01-01 00:04:17 +00:00
nix build .#raw
2023-12-31 00:33:48 +00:00
```
2024-01-01 00:04:17 +00:00
## features
- [X] file paths
- [X] global styles
- [X] custom components with styles
- [X] component extend / inheritance
### markdown
- [ ] frontmatter
- [X] headers
- [X] paragraphs
- [ ] tables
2024-01-01 14:51:59 +00:00
- [X] lists
2024-01-01 00:04:17 +00:00
- [ ] checkboxes
- [ ] images
- [ ] links
2024-01-01 14:06:54 +00:00
- [X] codeblocks
2024-01-01 00:04:17 +00:00
- [ ] subscript
2024-01-01 17:31:04 +00:00
- [X] highlight
- [X] italics
- [X] bold