Join Peter Gruenbaum for an in-depth discussion in this video Markdown solution, part of Learn API Documentation with JSON and XML.
(light tones ringing) - [Instructor] Here is the final document that you should have created as part of the challenge. Let's take a look at the Markdown that created it. The very first line is heading level one. And I made it level one by having just one hash mark here. Under that is some text and I made this status code italic by putting asterisks on either side of it, and I made the 404 monospace by putting backticks on either side of it. Next is a heading level two and it's heading level two because it's got two hash marks here.
Under that is our table. The table has a header row, and it's got Code and Description. They're separated by these pipes. Under that is a special row that's got some pipes and some dashes. And then under that is a table body where, again, you've got content and then you've got pipes to separate the content.
- The purpose of documentation
- Data types
- Structured data
- Writing JSON and XML
- Documenting one-level JSON responses
- Documenting nested JSON responses
- XML attributes and examples
- Documenting XML
- Structuring data documentation