add a readme
This commit is contained in:
parent
c10587f0c5
commit
cd87745a78
31
README.md
Normal file
31
README.md
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
|
||||||
|
# Nixite
|
||||||
|
|
||||||
|
A static site generator made in Nix.
|
||||||
|
|
||||||
|
## 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 build the site:
|
||||||
|
```sh
|
||||||
|
nix build .
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also serve it locally (using caddy)
|
||||||
|
```sh
|
||||||
|
nix run .#serve
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue