Markdown
A lightweight way of formatting plain text with symbols, such as # for headings and - for list items, that tools can display as formatted pages.
In more detail
Markdown files read well as raw text and render as formatted pages on sites such as GitHub. README files, changelogs and many documentation sites use it.
Examples
roles/web/README.md documents a role's contract.Changeset entries are small Markdown files with the version bump in a header.incident/postmortem.md.github/pull_request_template.mdRelated terms
- README — A text file, usually README.md, at the top of a project that explains what it does and how to use it.
- event filter — Keys under an event, such as branches, tags and paths, that narrow which pushes or pull requests start a workflow.
- job summary — Markdown a step appends to the file named by GITHUB_STEP_SUMMARY, shown on the run's summary page.
- Changesets — A tool where each pull request adds a small Markdown file describing its change and its version bump, later combined into releases and changelogs.
- changelog — A file or page listing the notable changes in each release of a project, newest first.
- postmortem — A written review after an incident that explains impact, timeline, contributing conditions and the follow-up actions that will change the system.
- linter — A tool that reads code or configuration without running it and flags likely mistakes and style problems.
- pull request template — A Markdown file in a repository whose text GitHub pre-fills into every new pull request description.
- release notes — A human-readable summary of what changed in a release: new features, fixes and anything users must do differently.
Taught in
- Structured Output — AI Engineering: LLM Apps, RAG & Agents
- Chunking And Ingestion — AI Engineering: LLM Apps, RAG & Agents
- Guardrails, Privacy And Governance — AI Engineering: LLM Apps, RAG & Agents
- The Standard Directory Layout And Roles — Ansible Configuration Management at Scale
- Vault IDs And Multiple Passwords — Ansible Configuration Management at Scale
- Triggers and the Event Model — Continuous Integration & Continuous Delivery Pipelines
- System Governance: Changesets, Semantic Versioning & Deprecation — Design Systems & Component Engineering
- Writing A Postmortem: The SRE Appendix — DevOps & Site Reliability Engineering
- Ignoring Files, And The Tracked File Trap — Advanced Git Internals & Distributed Workflows
- Tags And Releases — Advanced Git Internals & Distributed Workflows
References
- CommonMark specification
- CommonMark
- GitHub Docs: About writing and formatting on GitHub
- GitHub Docs: Basic writing and formatting syntax