Slate API Docs Generator icon

Slate API Docs Generator

Slate API Docs Generator icon

Slate API Docs Generator

  15
Бесплатное ПО Открытый код
Категории: Разработка
Платформы: Mac Linux
Ссылки: Официальный сайт
Особенности:
documentation-generator self-hosted api-documentation


Slate - красивая статическая документация для вашего API.

Особенности

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

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

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

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

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

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

Аналоги (27):

  • Doxygen

    Doxygen - это инструмент для генерации документации из аннотированных источников C ++, а также из других популярных ...
      48
    Бесплатное ПО Открытый код
    Mac Linux Windows
    haiku documenting-tools documenting-utility documenting-tool development-documentation development documentation documenting-utilities documenting development-tool structure
    Подробнее

  • swagger.io

    Swagger - это инструмент для документирования RESTapi с открытым исходным кодом.
      21
    Бесплатное ПО Открытый код
    Linux Web Windows Mac
    documentation-generator nodejs rest api node.js
    Подробнее

  • Daux.io

    Daux.io - это генератор документации, который использует простую структуру папок и файлы Markdown для ...
      12
    Бесплатное ПО Открытый код
    documentation self-hosted поддержка markdown documentation-generator php
    Подробнее

  • Docsie

    Docsie - это бесплатное программное обеспечение для совместной работы с программными документами, интранетом и управлением знаниями.
      11
    Бесплатное ПО
    Web
    markdown коллективное сотрудничество динамический ретаргетинг документация для программистов несколько языков document-collaboration делать заметки малый размер document-management поддержка wysiwyg локализация программного обеспечения note-taking documentation-generator api-documentation markdown-editor documentation collaboration-software база знаний document-processing dms wiki онлайн доступ markdown-export
    Подробнее

  • Wikitten

    Wikitten - это небольшая вики-хостинг, которая совместима с Markdown, HTML-страницами и ...
      8
    Бесплатное ПО Открытый код
    php personal-wiki documentation self-hosted wiki
    Подробнее

  • Sandcastle

    Sandcastle производит точную, MSDN стиль, всеобъемлющую документацию, размышляя над источником ...
      5
    Бесплатное ПО Открытый код
    Windows
    documentation-generator .net documentation net-framework .net framework
    Подробнее

  • Codex

    Codex - это простая файловая платформа документации Markdown, построенная на основе Laravel.
      4
    Бесплатное ПО Открытый код
    markdown documentation-generator documentation self-hosted laravel Не поддерживается
    Подробнее

  • NDoc

    NDoc генерирует документацию библиотеки классов из.
      4
    Бесплатное ПО Открытый код
    Windows
    documentation-generator .net documentation net-framework .net framework
    Подробнее

  • ReadMe

    ReadMe is a completely customizable and collaborative place for dynamic API and/or product...
      4
    Платное ПО
    Web
    documentation база знаний developer-hub documentation-generator api-documentation
    Подробнее

  • ApiGen

    ApiGen - это инструмент для создания профессиональной документации API из исходного кода PHP, похожий на ...
      3
    Бесплатное ПО Открытый код
    Mac Linux Windows
    api-documentation php-documentation
    Подробнее

  • DoxyS

    DoxyS - это инструмент документирования кода для C ++ / C.
      2
    Бесплатное ПО Открытый код
    Linux Windows
    documentation wiki html documenting
    Подробнее

  • Aglio

    API Blueprint Renderer
      1
    Бесплатное ПО Открытый код
    documentation-generator self-hosted documentation node.js
    Подробнее

  • CppDoc

    CppDoc генерирует HTML-документацию для классов C ++ на основе вашего исходного кода и специальных комментариев ...
      1
    Бесплатное ПО Открытый код
    Linux Windows
    documentation не требует установки documentation-generator programming Не поддерживается
    Подробнее

  • dAPI

    Node.js / JavaScript Dojo API viewer и статический просмотрщик API генератор документов.
      1
    Бесплатное ПО Открытый код
    endpoint self-hosted api
    Подробнее

  • Docuie

    Docuie предоставляет доступную документацию для отдельных разработчиков вплоть до предприятий ...
      1
    Платное ПО
    Web
    documentation документация для программистов
    Подробнее

  • Document! X

    Документ! X представляет собой комбинацию автоматизированного инструмента документирования и полной среды разработки ...
      1
    Платное ПО
    Windows
    programming java-development database-documentation javascript-tool visual-basic visual-studio html development-documentation javascript-development documentation development c-sharp documentor net-framework xml-schema vb.net net-development
    Подробнее

  • Javadoc

    Javadoc - это инструмент от Sun Microsystems для создания документации API в формате HTML из документа ...
      1
    Бесплатное ПО
    Mac Linux Windows
    documentation-generator html
    Подробнее

  • Natural Docs

    Natural Docs - это генератор документации с открытым исходным кодом для нескольких языков программирования.
      1
    Бесплатное ПО
    Mac Linux Windows
    documentation programming documentor perl
    Подробнее

  • DapperDox

    Генератор документации и сервер API с открытым исходным кодом для спецификаций OpenAPI Swagger.
      0
    Бесплатное ПО Открытый код
    Linux Windows
    documentation-generator открытый api rest api swagger
    Подробнее

  • DocsApp

    Лучшая платформа - ваш замечательный разработчик. Самый простой способ опубликовать красивую документацию по продукту.
      0
    Бесплатное ПО
    Linux Web Windows Mac Browser extension
    documentation api-documentation api-portal api
    Подробнее

  • LuaDoc

    Инструмент для генерации документации на языке Lua
      0
    Бесплатное ПО Открытый код
    Linux Windows
    lua-language documentation-generation lua-docs lua doc-tools script-documentation documentation-generators code-documentation documentation-generator doc-generation lua-doc docs-generator docs-tools docs-generation docs-generators docs-tool doc-generators doc-generator doc-tool lua-documentation documentation
    Подробнее

  • LDoc

    Генератор документации Lua
      0
    Бесплатное ПО Открытый код
    Linux Windows
    documentation-generator lua-docs lua lua-documentation lua-doc
    Подробнее

  • Shins

    Shins - это порт Slate для Node.JS / чистый Javascript.
      0
    Бесплатное ПО Открытый код
    Mac Linux Windows
    documentation slate api
    Подробнее

  • Doc-O-Matic

    Doc-O-Matic - это документация по исходному коду программного обеспечения и средство создания справки.
      0
    Платное ПО
    Windows
    windows-help c-plus-plus java visual-studio php jsp delphi javascript vb.net microsoft visual studio quality-assurance
    Подробнее

  • EDoC++

    EDoC ++ - это инструмент анализа исходного кода C ++, предназначенный для выявления проблем, связанных с использованием ...
      0
    Бесплатное ПО Открытый код
    Windows
    documentation c-plus-plus analysis-tool
    Подробнее

  • sharpDox

    sharpDox - инструмент документации для создания документации на языке C # любого типа.
      0
    Бесплатное ПО Открытый код
    Windows
    documentation-generator .net c-sharp documentation
    Подробнее

  • ForgeDoc

    ForgeDoc - это генератор документации библиотеки классов для сборок .NET.
      0
    Платное ПО
    Windows
    documentation-generator .net documentation net-framework documenter не требует установки .net framework
    Подробнее