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

Domen Kožar domen at dev.si
Wed Nov 18 18:51:50 CET 2015


I've once experimented and ported nixpkgs manual to
http://static.domenkozar.com/nixpkgs-manual-sphinx-exp/

But there doesn't seem to be of a much interest to make documentation more
approachable (something we did with github for code)

On Wed, Nov 18, 2015 at 6:47 PM, Matthias Beyer <mail at beyermatthias.de>
wrote:

> 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.
>
> _______________________________________________
> nix-dev mailing list
> nix-dev at lists.science.uu.nl
> http://lists.science.uu.nl/mailman/listinfo/nix-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.science.uu.nl/pipermail/nix-dev/attachments/20151118/6fb03685/attachment-0001.html 


More information about the nix-dev mailing list