Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.39 KB

readme.md

File metadata and controls

55 lines (33 loc) · 1.39 KB
Raw

Conix 0.2.0

Conix is a Nix EDSL for technical writing. It brings the Nix programming language alongside markdown and implements an intuitive build system.

Notice: This project is a work in progress. The API will be unstable until the first major release.

Documentation

A Readme File In Conix

Below is some conix code for generating a readme file^[Download Getting Started Sample Code] as HTML and Markdown files.

(import <nixpkgs> { overlays = import (builtins.fetchGit 
{ ref = "master"; rev = "3d63e3087f69b379be0cd5efbf56c28c7bf79b69"; url = "https://github.com/theNerd247/conix.git"; }); 
}).conix.run(conix: with conix;


markdown "readme" (html "readme" ''

# My Readme

This is a readme file!

''))

Contributing

Any ideas or help are welcome! Please submit a PR or open an issue as you see fit. I like to use the project board to organize my thoughts; check the todo column for tasks to work on. I will try and convert these to issues when I can.

Related Works

  • Pollen - "Pollen is a publishing system that helps authors make functional and beautiful digital books."

Acknowledgements

Many thanks to: