# slatedocs/slate

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/slatedocs-slate).**

36,082 stars · 364 forks · archived

## Links

- GitHub: https://github.com/slatedocs/slate
- Homepage: https://slatedocs.github.io/slate
- awesome-repositories: https://awesome-repositories.com/repository/slatedocs-slate.md

## Description

Slate is a static API documentation generator and reference website builder. It transforms API specifications and Markdown files into a professional, hosted static site used for developer portals and REST API referencing.

The tool creates a single-page API reference guide that integrates code samples and request-response examples. It utilizes a two-pane layout architecture to separate navigation from detailed endpoint descriptions.

The system includes a Markdown-based content pipeline and static site generation to produce flat HTML files. It provides client-side search indexing and a responsive design to ensure documentation is accessible across different device types.

## Tags

### Development Tools & Productivity

- [API Documentation Generators](https://awesome-repositories.com/f/development-tools-productivity/api-documentation-generators.md) — Generates professional static websites from API specifications to organize and display endpoints for developers. ([source](https://github.com/slatedocs/slate/blob/migration-notice/readme.md))
- [Reference Layouts](https://awesome-repositories.com/f/development-tools-productivity/rest-apis/reference-layouts.md) — Organizes complex API lists into a readable layout with a clear split between navigation and detailed descriptions.

### Content Management & Publishing

- [Markdown Documentation](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/documentation-tooling/authoring-editing/markdown-documentation.md) — Uses Markdown to structure and render technical documentation into a professional hosted static site.
- [Developer Portals](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/documentation-tooling/generation-publishing/developer-portals.md) — Acts as a centralized hub for technical guides and API references for developers integrating with web services.
- [Markdown Transformation Pipelines](https://awesome-repositories.com/f/content-management-publishing/content-processing-transformation/markdown-markup-tools/markdown-tools/markdown-renderers/markdown-transformation-pipelines.md) — Uses an automated pipeline to transform structured Markdown files into a professional static website layout.
- [Static-Site-Based Documentation](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/content-delivery-publishing/static-site-based-documentation.md) — Converts technical documentation files into a fast, searchable static website that requires no backend server.
- [Static Site Generation](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/static-site-generators/static-site-generation.md) — Pre-renders documentation pages into flat HTML files for high-performance delivery without a backend server.
- [API Reference Builders](https://awesome-repositories.com/f/content-management-publishing/static-site-document-generators/website-builders/api-reference-builders.md) — Provides a framework for creating single-page API reference guides with integrated code samples and response examples.

### User Interface & Experience

- [Dual-Pane Layouts](https://awesome-repositories.com/f/user-interface-experience/dual-pane-layouts.md) — Utilizes a side-by-side layout to separate navigation from detailed endpoint descriptions.

### Part of an Awesome List

- [API Documentation](https://awesome-repositories.com/f/awesome-lists/devtools/api-documentation.md) — Converts markdown into static, stylish API documentation.