Documentation with Markdown
Writing and publishing documentation in Markdown — syntax, structure, tables, code blocks and static-site generators.
- Markdown
- Docs-as-code
- Static sites
Demo lesson: A working demonstration lesson for this subject is available on this site. The full course is not yet published.
Learning outcomes
By the end, learners will be able to:
- 01
Write fluent Markdown
- 02
Structure multi-page documentation
- 03
Format code, tables and callouts
- 04
Publish docs with a static-site generator
Proposed module outline
A proposed structure — refined during curriculum development.
Headings, lists, links and emphasis.
Tables, code blocks and images.
Folders, navigation and front matter.
Docs in Git.
Static-site generators and hosting.
Real, working demo
Try a demonstration activity for this subject
An interactive demonstration built for this website shows the style and production quality of the learning experience.
Course enquiry
Interested in Documentation with Markdown?
Ask about availability, private training or having this curriculum developed for your organisation.
Send a message
The online form is not switched on yet. Please message me directly — your details below are already filled in.
Related training
- PlannedWritingBeginner
Technical Writing Fundamentals
Writing clear, concise, audience-focused technical content — structure, plain language, style and review.
- Plain language
- Structure
- Style guides
- PlannedWritingIntermediate
Software Documentation
Documenting software for users and developers — getting-started guides, how-tos, reference and release notes.
- Docs-as-code
- How-to guides
- Release notes
- PlannedWritingIntermediate
API Documentation Fundamentals
Documenting REST APIs — authentication, endpoints, parameters, examples, errors and OpenAPI specifications.
- REST
- OpenAPI
- Code samples