dhgms.docfx.mermaidjs.plugin
DocFX MermaidJs Image Generator Plugin
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.6%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
DocFX MermaidJs Image Generator Plugin
Basic Info
- Host: GitHub
- Owner: dpvreony
- License: mit
- Language: C#
- Default Branch: main
- Homepage: https://docs.dpvreony.com/projects/docfx-mermaidjs/
- Size: 757 KB
Statistics
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 4
- Releases: 30
Topics
Metadata Files
README.md
DocFx MermaidJS
Mission Statement
To provide a plugin to convert MermaidJS notations to diagrams during the build of a DocFX project.
Introduction
This DocFX MermaidJS plugin is a wrapper around the mermaid NPM package. It is aimed at doing build time generation of the mermaid diagram so:
- The syntax can be validated at build time.
- The image is only built once.
- The image can be embedded in a pdf.
Credits
- https://dotnet.github.io/docfx/
- https://mermaid.js.org/
- https://github.com/mermaid-js/mermaid-cli
- https://github.com/mermaid-js/mermaid
- https://github.com/dpvreony/article-statiq-mermaid
- https://github.com/KevReed/DocFx.Plugins.PlantUml
Getting Started
1. Create a console application (or similar)
2. Add a nuget package reference to "Dhgms.DocFX.Mermaid.Plugin" in your docfx_project
3. Add the following initialisation
cs
var options = new BuildOptions
{
// Enable MermaidJS markdown extension
ConfigureMarkdig = pipeline => pipeline.UseMermaidJsExtension(new MarkdownContext())
};
await Docset.Build("docfx.json", options);
You can see an example of this in
- The sample console application in this repository (github.com/dpvreony/docfx-mermaidjs/tree/main/src/Dhgms.DocFx.MermaidJs.Sample.Cmd)
- The console application in my main documentation repository (github.com/dpvreony/documentation/tree/main/src/docfx_project)
NOTES: * Only inline PNG is supported, this is due to a limitation in the plug in model and adding new files to the file cache on the fly. I may revisit this in future. The plug in itself exposes SVG data if you want to play with it.
You can adjust the settings by viewing the detailed documentation.
4. Adding a diagram
In your markdown files add a code block with a mermaid descriptor like so:
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
Then you can run the build and you should see the image output in place of the mermaid markdown syntax.
mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
Viewing the documentation
The documentation can be found at https://docs.dpvreony.com/projects/docfx-mermaidjs/
Contributing to the code
See the contribution guidelines.
Owner
- Name: David Vreony
- Login: dpvreony
- Kind: user
- Location: UK
- Website: http://www.dpvreony.co.uk
- Repositories: 39
- Profile: https://github.com/dpvreony
.NET Developer \ Analyst \ Architect with experience in Developer Experience, Financial Services and Healthcare domains
Citation (citation.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: DocFX MermaidJS Plugin
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: David
family-names: Vreony
orcid: 'https://orcid.org/0000-0001-6855-0779'
repository-code: 'https://github.com/dpvreony/docfx-mermaidjs'
license: MIT
GitHub Events
Total
- Create event: 112
- Release event: 5
- Issues event: 2
- Watch event: 3
- Delete event: 100
- Issue comment event: 207
- Push event: 526
- Pull request review event: 62
- Pull request event: 204
Last Year
- Create event: 112
- Release event: 5
- Issues event: 2
- Watch event: 3
- Delete event: 100
- Issue comment event: 207
- Push event: 526
- Pull request review event: 62
- Pull request event: 204
Committers
Last synced: 9 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| renovate[bot] | 2****] | 434 |
| dpvreony | d****y | 75 |
| dependabot[bot] | 4****] | 1 |
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 7
- Total pull requests: 481
- Average time to close issues: 9 months
- Average time to close pull requests: 5 days
- Total issue authors: 3
- Total pull request authors: 3
- Average comments per issue: 0.29
- Average comments per pull request: 1.2
- Merged pull requests: 426
- Bot issues: 2
- Bot pull requests: 470
Past Year
- Issues: 1
- Pull requests: 235
- Average time to close issues: N/A
- Average time to close pull requests: 6 days
- Issue authors: 1
- Pull request authors: 2
- Average comments per issue: 0.0
- Average comments per pull request: 1.07
- Merged pull requests: 194
- Bot issues: 0
- Bot pull requests: 227
Top Authors
Issue Authors
- dpvreony (4)
- renovate[bot] (2)
- arleybaron (1)
Pull Request Authors
- renovate[bot] (468)
- dpvreony (11)
- dependabot[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 3
-
Total downloads:
- nuget 10,814 total
-
Total dependent packages: 1
(may contain duplicates) -
Total dependent repositories: 0
(may contain duplicates) - Total versions: 32
- Total maintainers: 1
nuget.org: dhgms.docfx.mermaidjs.sample.cmd
MermaidJS Plugin for DocFX
- License: MIT
-
Latest release: 1.0.101
published about 126 years ago
Rankings
nuget.org: dhgms.docfx.mermaidjs.plugin
MermaidJS Plugin for DocFX
- License: MIT
-
Latest release: 4.0.25
published 6 months ago
Rankings
Maintainers (1)
nuget.org: docfx_project
MermaidJS Plugin for DocFX
- License: MIT
-
Latest release: 1.0.101
published almost 3 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-dotnet v3 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/init v2 composite
- glennawatson/setup-msbuild v1.0.3 composite
- actions/checkout v3 composite
- actions/create-release v1 composite
- actions/download-artifact v3 composite
- actions/setup-dotnet v3 composite
- actions/setup-java v3 composite
- actions/upload-artifact v3 composite
- crazy-max/ghaction-virustotal v3 composite
- dotnet/nbgv master composite
- glennawatson/ChangeLog v1 composite
- glennawatson/setup-msbuild v1.0.3 composite
- microsoft/vs-intellicode v1 composite
- dessant/lock-threads v4 composite
- Microsoft.Composition 1.0.31
- Microsoft.DocAsCode.Dfm 2.62.0
- 106 dependencies
- mermaid 10.4.0
- Microsoft.DocAsCode.App 2.67.5