GithubHelp home page GithubHelp logo

aceofbitcoin / mailcow-apiblueprint Goto Github PK

View Code? Open in Web Editor NEW

This project forked from mailcow/mailcow-apiblueprint

0.0 0.0 0.0 1.68 MB

The official mailcow API documentation

Shell 0.06% HTML 99.90% API Blueprint 0.03% Dockerfile 0.01%

mailcow-apiblueprint's Introduction

mailcow-apiblueprint

โš ๏ธ This project is deprecated and has been replaced by openapi docs can be found at your mailcow at /api or https://demo.mailcow.email/api/

Build Status

This project aims to provide the API documention for the mailcow: dockerized API.

How to generate the API documention

To generate the API documention from the apiary.apib file, you can simply execute following one-liner:

docker build . -t snowboard:latest
docker run -it --rm -v $PWD:/doc snowboard:latest snowboard html -o output.html -c config.yaml apiary.apib

mailcow-apiblueprint's People

Contributors

ntimo avatar andryyy avatar magiccc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.