Spring/spring-restdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish Slate sample's README

Browse Source
This commit is contained in:
Andy Wilkinson
2018-04-24 08:35:13 +01:00
parent a2b62e025a
commit 1e35e8279c
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
samples/rest-notes-slate/README.md
View File

@@ -14,11 +14,11 @@ open build/docs/api-guide.html
## Details
The bulk of the documentation is written in Markdown in the file named
[slate/api-guide.md.erb][2]. When the documentation is built, snippets generated by
[slate/source/api-guide.md.erb][2]. When the documentation is built, snippets generated by
Spring REST Docs in the [ApiDocumentation][3] tests are incorporated into this
documentation by [ERB][4]. The combined Markdown document is then turned into HTML.
[1]: https://github.com/tripit/slate
[2]: slate/api-guide.md.erb
[1]: https://github.com/lord/slate
[2]: slate/source/api-guide.html.md.erb
[3]: src/test/java/com/example/notes/ApiDocumentation.java
[4]: http://ruby-doc.org/stdlib-2.2.3/libdoc/erb/rdoc/ERB.html