https://github.com/robrohan/narrative
Narrative is a Literate Programming like workflow for making manuals and tutorials for code
https://github.com/robrohan/narrative
documentation literate-programming
Last synced: 17 days ago
JSON representation
Narrative is a Literate Programming like workflow for making manuals and tutorials for code
- Host: GitHub
- URL: https://github.com/robrohan/narrative
- Owner: robrohan
- License: mit
- Created: 2022-04-11T08:16:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-05T22:45:38.000Z (about 4 years ago)
- Last Synced: 2025-01-11T10:18:30.236Z (over 1 year ago)
- Topics: documentation, literate-programming
- Language: Go
- Homepage:
- Size: 297 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Introduction
Narrative is a technique to comment code to produce both the code itself, and at the same time create documentation (a manual, a tutorial, etc) about the code.
It is a similar idea to, and was inspired by, literate programming. Narrative is more focused on guiding someone through the code than on producing an academic paper.
[View example output from this codebase (work in progress)](testdata/manual.pdf)