8

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

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

2 ответа2

11

Извините за воскрешение очень старой темы. Я являюсь автором сценария mkd2vimdoc за первой ссылкой, предложенной ранее lornix . Я недавно переписал mkd2vimdoc с нуля как html2vimdoc . Он по-прежнему поддерживает Markdown в качестве входного формата; он преобразует Markdown в HTML, а затем преобразует этот HTML в файл справки Vim. При переписывании основное внимание уделялось поддержке более широкого диапазона входных документов.

Новый скрипт используется мной и несколькими другими авторами плагинов, поэтому он определенно предназначен для общего использования. Если вы хотите попробовать еще раз, я бы хотел узнать, работает ли он лучше для документов, на которых вы хотите его использовать. Если это все еще не работает, не стесняйтесь создавать проблемы на GitHub.

4

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

В то время как этот скрипт vim.org (github repo) конвертирует уценку в то, что выглядит почти как все, НО vimdoc. (вздыхает) Так близко ... может быть, небольшая модификация?

Всё ещё ищете ответ? Посмотрите другие вопросы с метками .