2016-07-05 2 views
2

Я использую Spring Rest Docs для создания документации. Я хотел бы сделать что-то вроде Bootstrap's Togglable tabs.Использование вкладок в AsciiDoc (Spring Rest Docs)

Весенняя документация использует togglable вкладки, но я не знаю, как это сделать. Вот пример (MockMvc/REST Assured): http://docs.spring.io/spring-restdocs/docs/1.1.0.RELEASE/reference/html5/#documenting-your-api Спасибо за помощь.

ответ

7

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

Вкладки в документации к документам Spring REST реализованы как небольшое расширение с использованием Groovy, CSS и Javascript. Если вы хотите взглянуть на код, он был добавлен в this commit.

С момента совершения совершения, расширение было перенесено в separate project. Релизы этого проекта доступны от https://repo.spring.io/release. Несколько подробностей о том, как использовать расширение, доступны в README.

+0

Это хороший материал, Энди. Есть ли у вас пример использования этой техники при создании собственной документации с помощью Spring REST Docs? – Gary

+1

После того, как я написал этот ответ, расширение было перенесено в отдельный проект. Я обновляю ответ со ссылкой на проект. Это README дает пример того, как его можно использовать. –

+0

Молодец, Энди. Это отлично работает. Вчера я просматривал этот старый пост и думал о том, чтобы сделать что-то подобное. Еще раз, команда Spring на несколько шагов впереди ... – Gary

Смежные вопросы