Markdown is a simple markup language that is becoming extremely popular for documenting APIs. It can be used by many tools. It works like HTML, but it's much simpler and easier to read. For this course, you are going to be using Markdown for documenting JSON and XML. This video explains how to use it.
- [Instructor] This lesson covers Markdown…which is a simple markup language.…As part of this course, you'll be asked…to write documentation.…Markdown is becoming a popular way…to write API documentation,…so I decided you should learn enough Markdown…to use it for the hands-on exercises.…What is Markdown?…It's a markup language like HTML is,…but it's much simpler.…It's very easy to learn,…and it's much easier to read than HTML.…It's used in many content tools…such as Sphynx, Jekyll, GitHub, and ReadMe.io…just to name a few.…
Here is a little more information about Markdown.…Special tools read in Markdown and convert it to HTML.…Markdown has no style information…which means that it's the tool…that actually controls the final look and feel.…There are different Markdown flavors.…If there's something you want to do in Markdown…that's not supported by that flavor,…then just add the HTML to do it…right in the Markdown content.…Now I'll show you how Markdown works.…Usually, lines together are considered part…of the same paragraph.…
- 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
Project Management: Iterative Methodswith Bob McGannon1h 16m Intermediate
Technical Writing: Reportswith Judy Steiner-Williams2h 30m Intermediate
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.