Skip to content

Commit

Permalink
Merge pull request #779 from apiaryio/kylef/apib-lexer
Browse files Browse the repository at this point in the history
Syntax highlight API Blueprint in documentation
  • Loading branch information
honzajavorek committed May 12, 2017
2 parents 67d5660 + 348d707 commit 524e3d9
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/how-to-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 /
Expand Down
14 changes: 14 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 524e3d9

Please sign in to comment.