GitHub — slatedocs / slate на webdesignernews.com

Особенности

• Чистый, интуитивно понятный дизайн — В Slate описание вашего API находится в левой части документации, а все примеры кода — в правой. На основе документов API Stripe и PayPal. Slate отзывчивый, поэтому отлично смотрится на планшетах, телефонах и даже в печати. ​​

• Все на одной странице — Прошли те времена, когда вашим пользователям приходилось искать по миллиону страниц, чтобы найти то, что они хотели. Slate помещает всю документацию на одну страницу. Однако мы не пожертвовали возможностью связывания. По мере прокрутки хэш вашего браузера будет обновляться до ближайшего заголовка, поэтому связывание с конкретным местом в документации по-прежнему будет естественным и простым.

• Slate — это просто Markdown — Когда вы пишете документы с помощью Slate, вы просто пишете Markdown, что упрощает редактирование и понимание. Все написано на Markdown — даже примеры кода — это просто блоки кода Markdown.

• Написание примеров кода на нескольких языках — Если ваш API имеет привязки на нескольких языках программирования, вы можете легко вставлять вкладки для переключения между ними. В своем документе вы будете различать разные языки, указав имя языка в верхней части каждого блока кода, как в случае с GitHub Flavored Markdown.

• Встроенная подсветка синтаксиса для более чем 100 языков, настройка не требуется.

• Автоматическая плавная прокрутка содержания в крайнем левом углу страницы. По мере прокрутки отображается ваше текущее положение в документе. Это тоже быстро. Мы используем Slate в TripIt для создания документации для нашего нового API, в котором наше оглавление содержит более 180 записей. Мы позаботились о том, чтобы производительность оставалась превосходной даже для больших документов.

• Разрешите пользователям обновлять вашу документацию за вас — По умолчанию ваша документация, созданная на Slate, размещается в общедоступном репозитории GitHub. Это не только означает, что вы получаете бесплатный хостинг для своих документов с помощью GitHub Pages, но и упрощает другим разработчикам отправку запросов на вытягивание в ваши документы, если они обнаруживают опечатки или другие проблемы. Конечно, если вы не хотите использовать GitHub, вы также можете разместить свои документы в другом месте.

• Поддержка RTL Полная раскладка справа налево для языков RTL, таких как арабский, персидский (фарси), иврит и т. Д.

Начать работу со Slate очень просто! Просто нажмите зеленую кнопку «использовать этот шаблон» выше и следуйте инструкциям ниже. Или, если вы хотите узнать, на что способен Slate, взгляните на образцы документации.

Начало работы с Slate

Чтобы начать работу со Slate, ознакомьтесь с Приступая к работе
раздел в нашей вики.

Мы поддерживаем запуск Slate тремя различными способами:

Компании, использующие сланец

Вы можете просмотреть больше в списке на вики.

Вопросы? Нужна помощь? Нашли ошибку?

Если у вас есть вопросы по настройке, развертыванию, реализации специальных функций в вашей вилке или вы просто хотите поговорить с разработчиком, начните обсуждение на нашей вкладке «Обсуждения»!

Нашли ошибку в исходной версии Slate? Идите вперед и отправьте вопрос. И, конечно же, не стесняйтесь отправлять запросы на включение с исправлениями ошибок или изменениями в ветку dev .

Авторы

Slate был построен Робертом Лордом во время работы в TripIt. В настоящее время проект поддерживают Мэтью Певелер и Майк Ральфсон.

Благодарю следующих людей, отправивших основные запросы на включение:

Также спасибо Sauce Labs за спонсирование разработки адаптивных стилей.

Особая благодарность