Skip to content

Commit 1d64eef

Browse files
authored
Update README.md
1 parent 6a14200 commit 1d64eef

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,8 @@ $ chmod +x /usr/bin/phpdraft
1414
$ phpdraft -f blueprint-file.apib > blueprint-webpage.html
1515
```
1616

17-
## Including Files
18-
It is possible to include other files in your blueprint by using a special include directive with a path to the included file relative to the current file's directory. Included files can be written in API Blueprint, Markdown or HTML (or JSON for response examples). Included files can include other files, so be careful of circular references.
19-
20-
```markdown
21-
<!-- include(filename.md) -->
22-
```
23-
24-
For tools that do not support this include directive it will just render out as an HTML comment. API Blueprint may support its own mechanism of including files in the future, and this syntax was chosen to not interfere with the [external documents proposal](https://github.com/apiaryio/api-blueprint/issues/20) while allowing `PHPDraft` users to include documents today.
25-
26-
_Thanks to [aglio](https://github.com/danielgtaylor/aglio) for the idea._
17+
## Extra features
18+
We got some fun stuff, check the [wiki](https://github.com/SMillerDev/phpdraft/wiki) for more.
2719

2820
## Writing API documentation
2921

0 commit comments

Comments
 (0)