nixite/README.md

1.3 KiB

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)

nix run .

Or you can build it raw (dumps the produced site into ./result)

nix build .#raw

Run the tests and watch for changes

nix run .#watch

features

  • file paths
  • global styles
  • custom components with styles
  • component extend / inheritance
  • templating

markdown

  • frontmatter
  • headers
  • paragraphs
  • tables
  • unordered lists
  • ordered lists
  • nested lists
  • checkboxes
  • links
  • images
  • block quotes
  • codeblocks are pretty neat
  • ~sub~script
  • ^super^script
  • ==mark== my words
  • italics emphasis insideofthe words_with_underscores
  • bold strong eveninwords but__dont__break
  • bold italics!
  • strikethrough everything