Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 3.71 KB

README.md

File metadata and controls

87 lines (64 loc) · 3.71 KB
Raw

Wardley Maps Plugin

This is plugin enables displaying and editing of Wardley Maps in the OnlineWardleyMaps format.

Usage

Add a code block to your markdown file using Source mode ```wardleymap include with a closing ```. View the raw source of this file to see an example below.

Example

title Tea Shop
anchor Business [0.95, 0.63]
anchor Public [0.95, 0.78]
component Cup of Tea [0.79, 0.61] label [-67.61, 4.90]
component Cup [0.73, 0.78] label [15.05, -10.00]
component Tea [0.63, 0.81]
component Hot Water [0.52, 0.80]
component Water [0.38, 0.82]
component Kettle [0.43, 0.35] label [-57, 4]
evolve Kettle->Electric Kettle 0.62 label [16, 5]
component Power [0.1, 0.7] label [-27, 20]
evolve Power 0.89 label [-12, 21]
Business->Cup of Tea
Public->Cup of Tea
Cup of Tea->Cup
Cup of Tea->Tea
Cup of Tea->Hot Water
Hot Water->Water
Hot Water->Kettle; limited by 
Kettle->Power

annotation 1 [[0.43,0.49],[0.08,0.79]] Standardising power allows Kettles to evolve faster
annotation 2 [0.48, 0.85] Hot water is obvious and well known
annotations [0.72, 0.03]

note +a generic note appeared [0.23, 0.33]

style wardley
size [800,400]

Getting Started

⚠️ Important: Installer Version Requirement
Wardley Maps requires a recent version of the Obsidian installer. If you experience issues with the plugin not loading properly:

  1. First, try updating Obsidian normally at Settings > General > Check for updates.

  2. If issues persist, manually update your Obsidian installer:

For more details, see Obsidian's guide on installer updates.

Currently, Wardley Maps is available through Beta Quickstart or Manual Installation. Community plugin support is coming soon.

Beta Quickstart (Recommended)

To install Obsidian Wardley Maps as a beta plugin:

  1. Install the BRAT plugin if you haven't already. Click here to install BRAT in Obsidian.
  2. Open the command palette and run the command "BRAT: Add a beta plugin for testing".
  3. Copy and paste this link into the modal: https://github.com/damonsk/obsidian-wardley-maps and click "Add Plugin" and wait for the installation.
  4. Go to Settings > Community plugins and refresh the list of plugins. Enable "Wardley Maps".

Manual Installation

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Create a folder named obsidian-wardley-maps in your vault's <Vault>/.obsidian/plugins/ directory.
  3. Place the downloaded files into this new folder.
  4. Open Obsidian settings Settings > Community plugins, and enable Wardley Maps.

License

This project is licensed under the AGPL-3.0 license.

Support the Project

If you find obsidian-wardley-maps, OnlineWardleyMaps or vscode-wardley-maps valuable, consider supporting its development:

Patreon

Follow on X (Twitter) @MapsAsCode for updates and announcements!

Your support helps maintain and improve this plugin as well as OnlineWardleyMaps and vscode-wardley-maps. Every contribution is appreciated. Thank you for your support!