Markdown and the art of reuse
summary
Claims a concrete feature: embed markdown snippets that enable reusable content across docs, implemented for Redocly and wired into a GitHub docs as code workflow with branches, commits and pull requests. Uses source control history and single sourcing to allow rollbacks and consistent updates. Proposal exists as an actual pull request, promising to cut maintenance effort and centralise shared content rather than just restating the benefits of markdown.
AI-written summary · about
chapters (4)
related talks
26mWhy Docs-as-Code Peer Review Should be Part of your Dev Cycle
42mTwo years of Markdoc: what we’ve learned about balancing developer and author experience
05mDocs as Part of the Product: Open Source Technical Documentation at Scale
35mBuilding Docs like Code: Continuous Integration for Documentation
19mBuilding Trust Across Teams Through Documentation
32mSwitching from Sphinx to Markdown
35mSwitching from Sphinx to Markdown
30mA Documentation Talk