[Nix-dev] [RFC] Generating documentation from nixpkgs (markdown files) with pandoc (Was: Real documentation, aka "Let's kill the wiki")

Matthias Beyer mail at beyermatthias.de
Wed Nov 18 18:47:12 CET 2015


I created a showcase on how to generate documentation from the nixpkgs
tree:

    https://github.com/matthiasbeyer/nixpkgs/tree/pandoc-documentation

Note:

    1) The documentation is still generated from .md files, not by
       parsing .nix files. This could be changed, but isn't trivial.

    2) I did not focus on release the full power of pandoc. I create a
       showcase, I want to show how it could work and that it actually
       works.

    3) To run:
        nix-shell shell.nix # Pulls Pandoc in a nix-shell
        make # calls pandoc

    4) I did not style anything, I did not create some files, there
       are already some .md files in the nixpkgs tree, I just use
       them to create some .html output

    5) As said in 4), I create .html output. PDF files could be
      created in a similar way.

This is an request for comments/commits.

-- 
Mit freundlichen Grüßen,
Kind regards,
Matthias Beyer

Proudly sent with mutt.
Happily signed with gnupg.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
Url : http://lists.science.uu.nl/pipermail/nix-dev/attachments/20151118/dce640ef/attachment.bin 


More information about the nix-dev mailing list