diff --git a/docs/hooks.md b/docs/hooks.md index 38f06769d..577317efe 100644 --- a/docs/hooks.md +++ b/docs/hooks.md @@ -49,7 +49,7 @@ In order to retrieve transaction names please run Dredd with the `--names` argum For example, given an API Blueprint file `api-description.apib` as following: -```markdown +```apiblueprint FORMAT: 1A # Machines API diff --git a/docs/how-to-guides.md b/docs/how-to-guides.md index 268d1786a..b52472742 100644 --- a/docs/how-to-guides.md +++ b/docs/how-to-guides.md @@ -16,7 +16,7 @@ To solve the situation, it's recommended to isolate the deletion test by [hooks] #### API Blueprint -```markdown +```apiblueprint FORMAT: 1A # Categories API @@ -169,7 +169,7 @@ For workflows to work properly, you'll also need to keep **shared context** betw Imagine we have a simple workflow described: -```markdown +```apiblueprint FORMAT: 1A # My Scenario @@ -443,7 +443,7 @@ Most of the authentication schemes use HTTP header for carrying the authenticati API Blueprint format supports `multipart/form-data` media type and so does Dredd. In the example below, Dredd will automatically add `LF` to all lines in request body: -```markdown +```apiblueprint # POST /images + Request (multipart/form-data;boundary=---BOUNDARY) @@ -473,7 +473,7 @@ API Blueprint format supports `multipart/form-data` media type and so does Dredd To test multiple requests and responses within one action in Dredd, you need to cluster them into pairs: -```markdown +```apiblueprint FORMAT: 1A # My API diff --git a/docs/quickstart.md b/docs/quickstart.md index f89420a1f..5f325660b 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -21,7 +21,7 @@ First, let's design the API we are about to build and test. That means you will If you choose API Blueprint, create a file called `api-description.apib` in the root of your project and save it with following content: -```markdown +```apiblueprint FORMAT: 1A # GET / diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..3bfa1aaa2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,14 @@ +appdirs==1.4.3 +click==6.7 +Jinja2==2.9.6 +livereload==2.5.1 +Markdown==2.6.8 +MarkupSafe==1.0 +mkdocs==0.16.3 +packaging==16.8 +Pygments==2.2.0 +pygments-markdown-lexer==0.1.0.dev39 +pyparsing==2.2.0 +PyYAML==3.12 +six==1.10.0 +tornado==4.5.1