Какой текстовый синтаксис Wiki или Markdown использовать?

Работа с моей личной базой знаний... Я хочу отформатировать документы даже на локальном жестком диске в синтаксисе wiki. Иногда я загружал их в (корпоративную) вики, иногда я бы загружал их оттуда. Запланированы некоторые инструменты для поддержки этого потока и поиска моей базы знаний (документов) для последующего использования. Очевидно, я хочу, чтобы уценка была совместима с большинством, сводя к минимуму работу по преобразованию.

Итак, мой вопрос похож на этот связанный вопрос, но

  • Какую текстовую версию wiki или Markdown (диалект) следует использовать, когда я начинаю что-то новое? (т.е. проект документации и вид вики).
  • Каковы наиболее используемые/признанные?
  • А где лучше всего поддерживается поддержка инструментов (редакторов и библиотек)? Обеспокоенная прог. языками являются Java, Ruby, Scala.

ОТВЕТЫ

Ответ 1

Википедия говорит, что нет общепринятого стандартного языка wikitext.

Creole - это одно из усилий для "обычного языка разметки вики, который будет использоваться в разных вики". Существует версия 1.0 спецификации, а несколько wikis и wiki engine реализуют ее. MediaWiki не реализует его.

Markdown имеет большое количество реализаций и, кажется, используется довольно много.

Поскольку нет согласованного стандарта, язык может быть выбран в зависимости от функций и доступных реализаций в зависимости от варианта использования.

Ответ 2

(1) Пока существует много разметки wiki, я предлагаю придерживаться четко определенного языка разметки.

Есть только 3 текстовые разметки с четко определенными спецификациями:

  • CommonMark пытается определить сильный синтаксис и стандартизировать общие расширения популярного MarkDown. Все любят это. Очень HTML-ориентированный.
  • reStructuredText является последовательной основой для разметки и хорошо зарекомендовавшего себя проекта (начата с 2001 года!). Если вам нужна расширяемость, встроенная в основные спецификации, встроенные внешние разметки, создайте HTML/PDF/docbook/etc, это ваш выбор. Несколько книг и много программных проектов были задокументированы через reStructuredText. Проверьте https://readthedocs.org/ Используя Sphinx программное обеспечение для публикации, которое вы когда-либо делали может построить HTML с автономным поиском JS!
  • AsciiDoc является конкурентоспособным по сравнению с reStructuredText, но с отсутствием встроенной расширяемости. Он очень ориентирован на DocBook. В AsciiDoc было написано несколько книг.

Textile разметка не получила четко определенных спецификаций и имела слабое сообщество. Я рекомендую рассмотреть выше 3 варианта.

(2) Вы обязательно должны придерживаться обычных текстовых файлов.

Поддержка программного обеспечения для всех вышеперечисленных форматов, способных производить высококачественный вывод для печати и онлайновой публикации.

Я придерживаюсь RST, потому что мне нужна расширяемость и возможность встроенной внешней разметки (математика с LaTeX, график с графикой/точкой, построение с помощью imagemagic и т.д.)

Я просматриваю личные советы внутри редактора Emacs или внутри bash/grep. В целях рекламы я публикую свои советы онлайн, например: http://tips.defun.work/

Ответ 3

К сожалению, в мире вики очень мало стандартизации формата, хотя некоторые вики (в частности, атласский Confluence, коммерческий продукт) перемещаются к XHTML.

Наиболее широко используемым программным обеспечением Wiki является MediaWiki (из Википедии). Разметку Mediawiki классно трудно разобрать, но она существует и используется достаточно широко, что существует множество существующих инструментов для преобразования как в MediaWiki, так и из них формат, а также редактирование контента с большим количеством различных онлайн-и автономных редакторов.

MediaWiki также имеет полнофункциональный API с большим количеством клиентских библиотек на разных языках программирования (см. Клиентский код), включая, например. MediaWiki:: Gateway для Ruby.