2023-12-31 00:33:48 +00:00
|
|
|
# Nixite
|
|
|
|
|
|
|
|
|
|
A static site generator made in Nix.
|
|
|
|
|
|
2023-12-31 04:27:09 +00:00
|
|
|
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-02 04:01:19 +00:00
|
|
|
Or you can build it raw (dumps the produced site into ./result)
|
2024-01-01 00:04:17 +00:00
|
|
|
|
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-02 04:01:19 +00:00
|
|
|
Run the tests and watch for changes
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
nix run .#watch
|
|
|
|
|
```
|
|
|
|
|
|
2024-01-01 00:04:17 +00:00
|
|
|
## features
|
|
|
|
|
|
|
|
|
|
- [X] file paths
|
|
|
|
|
- [X] global styles
|
|
|
|
|
- [X] custom components with styles
|
|
|
|
|
- [X] component extend / inheritance
|
2024-01-01 20:27:05 +00:00
|
|
|
- [ ] templating
|
2024-01-01 00:04:17 +00:00
|
|
|
|
|
|
|
|
### markdown
|
|
|
|
|
|
|
|
|
|
- [ ] frontmatter
|
|
|
|
|
- [X] headers
|
|
|
|
|
- [X] paragraphs
|
|
|
|
|
- [ ] tables
|
2024-01-01 14:51:59 +00:00
|
|
|
- [X] lists
|
2024-01-01 20:27:05 +00:00
|
|
|
- [ ] embedded lists
|
|
|
|
|
- [X] checkboxes
|
2024-01-01 00:04:17 +00:00
|
|
|
- [ ] images
|
|
|
|
|
- [ ] links
|
2024-01-01 20:27:05 +00:00
|
|
|
- [X] `codeblocks`
|
|
|
|
|
- [X] ~superscript~
|
|
|
|
|
- [X] ^subscript^
|
|
|
|
|
- [X] ==highlight==
|
|
|
|
|
- [X] *italics*
|
|
|
|
|
- [X] **bold**
|
|
|
|
|
- [X] ~~strikethrough~~
|
2024-01-01 17:31:04 +00:00
|
|
|
|
