Skip to main content

MarkdownUSM is the best way to draw a beautiful user story mapping diagram from simple markdown file.

Project description

MarkdownUSM

MIT License CircleCI codecov Supported Versions Code style: black Imports: isort

MarkdownUSM is the best way to draw a beautiful user story mapping diagram from simple markdown file.
Markdown file will be converted to XML format then you can easily use the diagram on draw.io and export in another format.

Installation

$ pip install markdownusm

Examples

Create it

Create a file sample.md with:

<!-- Comment -->

<!-- Release titles -->
- Release 1
- Release 2
- Release 3
- Release 4
- Release 5

# Activity 1
## Task 1
Story 1
--- <!-- Release separator -->
Story 2
---
Story 3

## Task 2
---
Story 4

<!-- Suffix `!` changes story postit color for warning -->
Story 5!

# Activity 2
## Task 3
---
---
Story 6 &lt;br&gt; Next line
<!-- Story can change their colors by setting hex code following story title -->
Story 7 #a6dfb5

Run it

The simplest way with:

$ musm sample.md

<mxfile>
    <diagram>
        <mxGraphModel dx="661" dy="316" grid="0" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0" background="#FFFFFF">
        ...

Output XML file with:

$ musm -o sample.dio sample.md

License

This project is licensed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdownusm-0.1.0.post3.tar.gz (10.9 kB view hashes)

Uploaded Source

Built Distribution

markdownusm-0.1.0.post3-py3-none-any.whl (13.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page