An opinionated markup language for composing, documenting, and visualizing a novel.
Project description
Monkeytale v0.2.2
"The book is a program." - Matthew Butterick
Monkeytale is a markup language for documenting and composing a story world and its novels within flat files. I am building this language to meet my opinionated needs for improving insights into my own writing.
Design Principles
- Don't opine. Document.
- Story structure lives within the writing, not in file and folder structure
- Only flat files with version control
- Simple syntax
- No configuration
Planned Functionality
- Compose multiple narratives (re)using story components
- Execute from continuous integration server
- Derive story structure knowledge from story components and their content
- Provide plugin mount point for generation of documents from story structure extracted by Monkeytale
- Navigate to any named story component
Dismissed Functionality
- Advice on how to improve or correct the writing
- Typography and formatting, other than emphasis (italics)
- Tables of content and indexing
- Project management and goal tracking (unless hard deadlines ever become a reality for me)
- Stuff other folks have done better
Development Progress
Monkeytale is developed in spare time and uses Semantic Versioning and Semantic Release to track its, equally spare, progress.
As per Semantic Versioning: "Major version zero (0.y.z) is for initial development. Anything MAY change at any time. The public API SHOULD NOT be considered stable."
Check the change log for the latest updates.
Decisions
- Python 3 will be the programming language for Monkeytale and any plugins that folks might want to build
- Visual Studio Code (VSCode) will be the text editor of choice
- GruntFuggly's ToDoTree extension for VS Code will be used to support navigation
- Markdown Preview Enhanced extension for Markdown and Mermaid diagram display and conversion to docx using PanDoc and PDF using Safari.
- Github Actions as execution platform
- Use .@ as the file extension to indicate Monkeytale files
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for monkeytale-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55fc469d28f0fd8348a3199ea9e5270645d0cdb15d0a121256d6fc3c395c554d |
|
MD5 | c6d792b4c6ad8e88884ff02160461971 |
|
BLAKE2b-256 | bbebb08fcd3c74490ac79bc6e3a6e27081839f17d1fe727ac97ef055a4b11ad3 |