[Nix-dev] Real documentation, aka "Let's kill the wiki"
zimbatm
zimbatm at zimbatm.com
Tue Nov 24 22:14:50 CET 2015
Please no XML as the source, it adds way too much emphasis on the structure
instead of the content.
Asciidoc is pretty good. It can be configured quite close to markdown
<http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#markdown-compatibility-asciidoctor-only>
and supports all the nice things that you need for bigger documents like
TOC, includes, simple macros and list definitions, ...
On Tue, 24 Nov 2015 at 15:02 Emmanuel Surleau <emmanuel.surleau at gmail.com>
wrote:
> To generate docsets for zeal: https://kapeli.com/docsets
>
> On Tue, Nov 24, 2015 at 3:25 PM, Matthias Beyer <mail at beyermatthias.de>
> wrote:
>
>> On 24-11-2015 15:00:33, Profpatsch wrote:
>> > On 15-11-23 08:03pm, Jan Malakhovski wrote:
>> >
>> > I thought about this in the past, as a first step it would be a killer
>> > feature to be able to use the documentation on the system with
>> > https://zealdocs.org/ (as compared to using the outdated versions
>> provided
>> > by default).
>> >
>>
>> While I consider zeal a really great idea, I would like to note that
>> plain-text access is essential. I don't know whether this is possible
>> if we ship documentation through zeal and even if it is possible: Is
>> it still readable? I don't know anything about the formats zeal uses.
>>
>> The proposal I filed for compiling markdown sources from the nixpkgs
>> repository into pdf or html could be used for shipping documentation
>> with zeal, if zeal is able to include the html I generate with pandoc,
>> right?
>>
>> --
>> 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
>>
>>
> _______________________________________________
> 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/20151124/a5e4cea0/attachment-0001.html
More information about the nix-dev
mailing list