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
Skill Level Intermediate
Agile Project Management Principleswith Bob McGannon1h 16m Appropriate for all
Technical Writing: Reportswith Judy Steiner-Williams2h 30m Appropriate for all
Introduction to JSON and XML Documentation
Next steps1m 10s
- Mark as unwatched
- Mark all as unwatched
Are you sure you want to mark all the videos in this course as unwatched?
This will not affect your course history, your reports, or your certificates of completion for this course.Cancel
Take notes with your new membership!
Type in the entry box, then click Enter to save your note.
1:30Press on any video thumbnail to jump immediately to the timecode shown.
Notes are saved with you account but can also be exported as plain text, MS Word, PDF, Google Doc, or Evernote.