diff --git a/README.md b/README.md index a73851d..e979155 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,18 @@ -

- Slate: API Documentation Generator -
- Build Status - Docker Version -

+mod.io +# mod.io REST API Docs +[![Build Status](https://github.com/slatedocs/slate/workflows/Build/badge.svg?branch=main)](https://github.com/slatedocs/slate/actions?query=workflow%3ABuild+branch%3Amain) +[![Docker Version](https://img.shields.io/docker/v/slatedocs/slate?sort=semver)](https://hub.docker.com/r/slatedocs/slate) +[![Discord](https://img.shields.io/discord/389039439487434752.svg?label=Discord&logo=discord&color=7289DA&labelColor=2C2F33)](https://discord.mod.io) +[![Master docs](https://img.shields.io/badge/docs-master-green.svg)](https://docs.mod.io/restapiref/) -

Slate helps you create beautiful, intelligent, responsive API documentation.

+REST API Documentation for [mod.io](https://mod.io) is powered by [slate](https://github.com/lord/slate), a static API generator and can be [read here](https://docs.mod.io/restapiref/) (also see our [getting started guide](https://docs.mod.io)). We use [swagger.io](https://swagger.io) to define our API from comments in our codebase, and generate the slate markdown files from it using [widdershins](https://github.com/modio/widdershins). + +To make changes to the introduction, please submit pull requests on the markdown file [_modio.md](source/includes/_modio.md), and to update the changelog, please submit pull requests on the markdown file [_changelog.md](source/includes/_changelog.md). -Documentation for [mod.io](https://mod.io) is powered by [slate](https://github.com/lord/slate), a static API generator and can be [read here](https://docs.mod.io) (also see our [getting started guide](https://blog.mod.io/getting-started-blog-fa404d59e3dd)). We use [swagger.io](https://swagger.io) to define our API from comments in our codebase, and generate the slate markdown files from it using [widdershins](https://github.com/Mermade/widdershins). +------------ +

Slate: API Documentation Generator

+

Slate helps you create beautiful, intelligent, responsive API documentation.

The example above was created with Slate. Check it out at slatedocs.github.io/slate.

Features