Join Peter Gruenbaum for an in-depth discussion in this video Markdown challenge, part of Learn API Documentation with JSON and XML.
- [Instructor] Time for a challenge to let you actually write some markdown. You'll get a chance to practice formatting, as well as practice creating headings and tables. You'll use the StackEdit online editor. So let me show you what that looks like. I've opened up a browser and I've gone to StackEdit.io, and you can see there's a Start writing now button right here. I'll click on that. So you'll ese an editor like this. You might see some text on the left side. If you have, you can just select it all and delete it, but then you basically just type in the left side.
This is my documentation, and you'll immediately see it show up in the right side, and if you add some special markdown, like, say two asterisks on either side of documentation, you'll see immediately that it bolds the documentation on the right side. So that's how you can see what you're doing. Follow the instructions in the exercise file. You'll find it in the Exercise Files folder under Chapter 00. It's the file named MarkdownChallenge. Read through and try the exercise. After you're done, watch the next video to see how I solved it.
- 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