Какой синтаксис вики-текста или Markdown использовать? - PullRequest
11 голосов
/ 11 января 2011

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

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

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

Ответы [ 3 ]

13 голосов
/ 13 марта 2012

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

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

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

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

2 голосов
/ 18 февраля 2016

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

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

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

Текстильная разметка не получила четко определенных характеристик и имеет слабое сообщество вокруг. Я рекомендую рассмотреть выше 3 варианта.

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

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

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

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

1 голос
/ 06 июня 2011

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

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

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

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...