Можно ли отобразить документ asciidoc в github?

Могу ли я отображать файл asciidoc на github так же, как я могу в настоящее время просматривать файл уценки? Согласно этой записи в блоге, я должен быть в состоянии сделать это:

Если вы заинтересованы в использовании AsciiDoc, перейдите на GitHub и создайте новый файл в одном из ваших репозиториев или списков, используя расширение файла.asciidoc или.adoc.

Однако я попытался сделать это, и это не сработало. Может кто-нибудь сказать мне, как получить документ asciidoc для отображения хорошо отформатированного текста на Github?

Вот документ, который я пытался проверить с помощью Asciidoc. https://github.com/00krishna/proj_blog/blob/master/test.adoc

1 ответ

Решение

Ваш файл синтаксически недействителен (или, скорее, строка рассматривается как простой текст).

Ваш оригинальный файл:

==This is a test
this is a test of using asciidoc

Там нет места после ==; Я считаю, что это необходимо.

Измененная версия, которая отображается правильно:

== This is a test
this is a test of using asciidoc

Увидеть test.adoc а также test2.adoc в этом Гисте.

Синтаксис этой функции "Заголовки в одну строку" задокументирован в руководстве пользователя Asciidoc, раздел 11.2.

В качестве дополнения к принятому ответу Github (или, по крайней мере, часть Wiki Github) принимает только .asciidoc суффикс. .adoc а также .ad не похоже на работу. Я только столкнулся с этим, потому что я пытался вручную изменить страницы в вики из .md в .ad и они не будут отображаться, поэтому проверьте это, если ваша проблема не устранена.

Другие вопросы по тегам