https://github.com/peter88213/manuskript_md
A Python script to create Markdown-formatted text files from a Manuskript project.
https://github.com/peter88213/manuskript_md
Last synced: 9 days ago
JSON representation
A Python script to create Markdown-formatted text files from a Manuskript project.
- Host: GitHub
- URL: https://github.com/peter88213/manuskript_md
- Owner: peter88213
- License: mit
- Created: 2023-12-20T20:07:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-27T08:27:19.000Z (over 1 year ago)
- Last Synced: 2023-12-27T20:41:08.813Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 82 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# manuskript_md
A Python script to create Markdown-formatted text files from a [Manuskript](https://www.theologeek.ch/manuskript/) project.
## Features
- Creates *world.md*, a Markdown-formatted text file containing the story world descriptions.
The heading levels reflect the hierarchy in *Manuskript*.
- Creates *characters.md*, a Markdown-formatted text file containing the character data.
The first level headings show the characters' names.
The character information is structured on the second level.
- Creates *manuscript.md*, a Markdown-formatted text file containing all chapters and scenes.
- Creates synopses on all levels (up to 6) of the Manuskript *Outline*:
- Full chapter summaries in a document per chapter level.
- Short chapter summaries in a document per chapter level.
- Full scene summaries.
- Short scene summaries.
- Scene titles.
- You can control which documents are created with the command line parameters.
## Requirements
- A [Python](https://www.python.org/) installation (version 3.6 or newer).
## Download
Save the file [mskmd.py](https://raw.githubusercontent.com/peter88213/manuskript_md/main/mskmd/mskmd.py).
## Usage
You can start the script either from the command line, or
from a batch file or shell script (that may launch *pandoc* afterwards).
```
usage: mskmd.py [-h] [-o] [-w] [-c] projectdir
Create Markdown-formatted text files from a Manuscript project.
positional arguments:
projectdir The Manuskript project directory.
options:
-h, --help show this help message and exit
-o, --outline Create markdown-formatted files for all levels of the
Manuskript outline.
-w, --world Create a "world.md" file.
-c, --characters Create a "characters.md" file.
The created text files are placed in the Manuskript project directory.
```
As a *Manuskript* user you probably have [pandoc](https://pandoc.org/) installed,
so you can convert the Markdown-formatted text files into many other document formats,
such as odt or docx.
Here's how the command looks like for converting the *world.md* file into
*world.odt* for LibreOffice:
`pandoc -o world.odt -fMarkdown-smart world.md`
## See also
[manuskript-exporter](https://github.com/peter88213/manuskript-exporter) is a simple
Python application based on the *mskmd* module. It lets you select the output format
and creates Markdown, ODT, DOCX, and HTML documents.
## License
Published under the [MIT License](https://opensource.org/licenses/mit-license.php)