Skip to content
This repository has been archived by the owner on Sep 26, 2022. It is now read-only.
/ AMP Public archive

API Markdown Processor for API Blueprints

License

Notifications You must be signed in to change notification settings

analogjupiter/AMP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AMP - API Markdown Processor

AMP is a free Markdown Processor for API definitions. It aims to be partially compatible with API Blueprint.

Installation

  1. Install Drafter v4 (just stick to its docs)
  2. Follow these instructions:
# Clone this repository and navigate into it:
git clone --recurse-submodules https://github.com/voidblaster/AMP.git
cd AMP


# (optional)
# Build the factory template in the `factory-template` directory
#   --> check its own README for help


# Build AMP using DUB:
cd AMP
dub build --build=release


# Show usage information:
bin/amp --help

Dependencies

  • AMP Factory Template
    • (c) Markus Leimer
    • License: CC-BY-4.0
    • Used as template for HTML files.
  • Drafter
    • (c) Apiary Inc.
    • License: MIT
    • Used for parsing API Blueprint files.
  • Mustache-D
    • (c) Masahiro Nakagawa
    • License: BSL-1.0
    • Used for generating HTML files.