Генерування довідкових файлів для vim

8

В даний час я пишу свою документацію безпосередньо як довідкові файли vim. Іноді мені потрібно генерувати інші формати (наприклад, PDF). Мій робочий процес полягає в тому, щоб скопіювати вміст файлів довідки та перетворити їх на щось необхідне. Це досить виснажлива робота, оскільки мені в основному доводиться додавати додаткову розмітку.

Мені подобається підхід Markdown, який можна (наприклад, за допомогою Pandoc) перетворити на різноманітні вихідні формати. На жаль, не довідкові файли vim. Я шукаю конвертер, який приймає стандартний формат введення (наприклад, XML, Markdown, reStructed Text, звичайний текст, ...) і виводить файл довідки vim. Або є якісь інші засоби автоматичного генерування довідкових файлів vim, не записуючи сам такий конвертер?

vim

— Марко
джерело

Ви, ймовірно, зможете зіткнути таблицю стилів XSLT за кілька годин.

— Ігнасіо Васкес-Абрамс

11

Вибачте за відродження дуже старої нитки. Я автор mkd2vimdocсценарію за першим посиланням, запропонованим lornix раніше. Я нещодавно переписав mkd2vimdocз нуля як html2vimdoc . Він як і раніше підтримує Markdown як формат введення; він перетворить Markdown у HTML, а потім перетворить цей HTML у файл довідки Vim. Під час переписування було зосереджено увагу на підтримці більш широкого кола вхідних документів.

Новий сценарій використовується мною та кількома іншими авторами плагінів, тому він, безумовно, призначений для загального використання. Якщо ви хочете спробувати ще раз, я хотів би почути, чи працює він зараз краще для документів, на яких ви хочете використовувати його. Якщо це все ще не працює, сміливо створіть проблему на GitHub.

— xolox
джерело

3

Ласкаво просимо до SuperUser! Відповіді на старі питання тут оцінені, деякі люди все ще можуть шукати відповіді на них, і це добре, щоб покращити старі.

— gronostaj

4

Я знайшов цей сценарій, який автор створив для перетворення розмітки у документацію vim. Звучить дуже близько до того, що ви шукаєте.

Хоча цей скрипт vim.org ( github repo ) перетворює розмітку в те, що схоже майже на все, але НЕ vimdoc. (зітхає) Так близько ... може, незначна модифікація?

— лорікс
джерело

Перший сценарій непридатний для загального використання. Це може працювати для стилів розмітки авторів, але він не конвертував жодного з моїх (дійсних) файлів розмітки правильно. Другий варіант - pandoc, дуже здатний конвертер, який мені дуже подобається. На жаль, він не підтримує vimhelp. Я попросив у списку розсилки додати підтримку, але відповідь полягала в тому, що vimhelp - це не вихідний формат загального призначення, а спеціалізований формат, призначений для документації на vim, на відміну від інших підтримуваних форматів. У будь-якому випадку, велике спасибі за пораду.

— Марко

Мені цікаво, що може спричинити створення перетворювача від розмітки до vimdoc, оскільки більшість vimdoc є форматуванням та спеціальними символами маркера, тоді як магія виконується командою helptags та самим переглядачем довідки vim. Звичайно, я можу (знову) класти ногу в рот ... можливо, це залежить від складності вашої початкової відмітки.

— lornix

Розумне рішення, запропоноване у списку розсилки, було створити vimhelp, який також є дійсним розміткою. Недоліком є те, що розмітка трохи захаращена синтаксисом vim і файли vimhelp не підкоряються умовам форматування. Але крім цього він є корисним.

— Марко