Можно ли подавить или изменить заголовки «Введение» и «Справочник» в редакторе документации API Apiary.io? - PullRequest
0 голосов
/ 12 июня 2019

По умолчанию https://apiary.io/ добавляет заголовки «Введение» и «Справочник» в документацию API.Заголовки не отображаются во встроенном редакторе, и кажется, что невозможно их подавить или добавить дополнительные заголовки в том же стиле.

Я знаком с Markdown и изучил основыMSON, но до сих пор мне не удалось найти решение.

1 Ответ

0 голосов
/ 12 июня 2019

(я работаю на пасеке)

Введение и Ссылка являются ключевыми группами в Оглавление (ToC) в документации API для пасеки и не могут быть изменены.

ToC также виден на странице редактора, если окно вашего браузера достаточно широко (вы можете перетаскивать разделитель между редактором / предварительным просмотром, чтобы увеличить предварительный просмотр).

Предлагаемый способ структуры вашего документа описания API (ADD) состоит в том, чтобы иметь один # API Name, затем кратный ## Group ... с ### Resource XYZ [/path/to/it] для этих групп (групп) =, так что вы увидите результаты в ToC красиво отображается.

...