Code Samples that Actually Compile
summary
Makes code examples in markdown actually compile by extracting real code from the repository using the tool MD snippets. Source files get marker comments like begin snippet my_example ... end snippet my_example, markdown files use a corresponding snippet my_example include, and the generator expands them into a .sourced.md, inserts a link to the exact source lines, and fails on missing snippet so broken examples are caught. Language-agnostic, used with tests and production code, and keeps docs automatically up-to-date.
AI-written summary · about
chapters (6)
related talks
28mBeyond Skeuomorphic Markdown
05mLightning Talk: majsdown: Metaprogramming? In my Slides?
28mCreating Quality Sample Code
04mLive Coding
37mCode the documentation instead of documenting the code
05mMarkdown and the art of reuse
34mCode the Docs: Interactive Document Environments
55mCode that writes code - .NET Source generators