From 80ef9d27994b259f8b15197c56c72030aec7f659 Mon Sep 17 00:00:00 2001 From: maulwuff Date: Tue, 17 Oct 2017 09:13:46 +0200 Subject: [PATCH] doc: added nomnoml specs --- readme.md | 2 +- src/Markdig.Tests/Specs/DiagramsSpecs.md | 31 ++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 6ffb6de33..7eaf985d4 100644 --- a/readme.md +++ b/readme.md @@ -47,7 +47,7 @@ You can **try Markdig online** and compare it to other implementations on [babel - [**Emoji**](src/Markdig.Tests/Specs/EmojiSpecs.md) support (inspired from [Markdown-it](https://markdown-it.github.io/)) - [**SmartyPants**](src/Markdig.Tests/Specs/SmartyPantsSpecs.md) (inspired from [Daring Fireball - SmartyPants](https://daringfireball.net/projects/smartypants/)) - [**Bootstrap**](src/Markdig.Tests/Specs/BootstrapSpecs.md) class (to output bootstrap class) - - [**Diagrams**](src/Markdig.Tests/Specs/DiagramsSpecs.md) extension whenever a fenced code block contains a special keyword, it will be converted to a div block with the content as-is (currently, supports only for [`mermaid` diagrams](https://knsv.github.io/mermaid/)) + - [**Diagrams**](src/Markdig.Tests/Specs/DiagramsSpecs.md) extension whenever a fenced code block contains a special keyword, it will be converted to a div block with the content as-is (currently, supports [`mermaid`](https://knsv.github.io/mermaid/) and [`nomnoml`](https://github.com/skanaar/nomnoml) diagrams) - [**YAML frontmatter**](src/Markdig.Tests/Specs/YamlSpecs.md) to parse without evaluating the frontmatter and to discard it from the HTML output (typically used for previewing without the frontmatter in MarkdownEditor) - [**JIRA links**](src/Markdig.Tests/Specs/JiraLinks.md) to automatically generate links for JIRA project references (Thanks to @clarkd: https://github.com/clarkd/MarkdigJiraLinker) - Compatible with .NET 3.5, 4.0+ and .NET Core (`netstandard1.1+`) diff --git a/src/Markdig.Tests/Specs/DiagramsSpecs.md b/src/Markdig.Tests/Specs/DiagramsSpecs.md index 31fa8616a..495c8fbca 100644 --- a/src/Markdig.Tests/Specs/DiagramsSpecs.md +++ b/src/Markdig.Tests/Specs/DiagramsSpecs.md @@ -23,4 +23,35 @@ graph TD; ```````````````````````````````` +## nomnoml diagrams + +Using a fenced code block with the `nomnoml` language info will output a `
` instead of a `pre/code` block: + +```````````````````````````````` example +```nomnoml +[example| + propertyA: Int + propertyB: string +| + methodA() + methodB() +| + [subA]--[subB] + [subA]-:>[sub C] +] +``` +. +
[example| + propertyA: Int + propertyB: string +| + methodA() + methodB() +| + [subA]--[subB] + [subA]-:>[sub C] +] +
+```````````````````````````````` + TODO: Add other text diagram languages \ No newline at end of file