Re: vim-artige Dokumentation erstellen
Hallo Andre!
Andre Tann schrieb am Mittwoch, den 30. Dezember 2015:
> Servus zusammen,
>
> ich möcht gerne eine Dokumentation erstellen. Alles muß komplett in der
> CLI anzeigbar sein. Allerdings hätte ich gerne auch Links, so ähnlich
> wie in der vim-Dokumentation. Hat jemand dafür einen Lesetipp für mich?
> Oder gibts vielleicht auch schon was fertiges, was ich benutzen könnte?
Hm, wenn du eh Vim nutzt, dann kannst Du doch die Doku auch gleich als
Vim helpfile schreiben¹. Wenn du dann noch ein Vim Plugin Manager
benutzt, dann wird das Tagsfile automatisch aktualisiert und du mußt
nicht noch händisch :helptags ausführen.
Mittels :TOhtml könntest Du das ganze auch noch als HTML exportieren.
Wichtig wäre halt nur, dass du einen passenden Namespace verwendest, um
nicht mit den Links aus der Vim Doku zu kollidieren.
¹) Das ist nicht so schwer. Sprungziele werden als *Anker* definiert.
Links dann als |Link| Dazu noch ein bißchen spezielle Syntax, die aber
vermutlich nicht weiter relevant ist. Siehe auch :h help-writing und :h
write-local-help
Grüße
Christian
--
Hallo Schrebergartenhäuschenbesitzer!
Reply to: