XMindCSharp

XMind API for C#


XMindCSharp AppVeyor Badge NuGet Badge XMindCSharp on fuget.org Conventional Commits

XMind API that allows to build .xmind files programmatically

Install

dotnet add package XMindCsharp --version X.Y.Z

Getting Started

var book = new XMindConfiguration()
                .WithFileWriter("./output", zip: true)
                .CreateWorkBook(workbookName: "test.xmind");
var sheet = book.CreateSheet();
book.AddSheet(sheet, 0); //replaced primary sheet

Example

Here is what you can do with it: edu-scope-to-mindmap

Full source code could be found at edu-scope-to-mindmap.

Running the tests

Run following command from the root folder:

dotnet test ./XMindAPI.Tests/

Scope

Contribute

Git Commit Guidelines:

<type>[optional scope]: <description>

[optional body]

[optional footer]

Type

Must be one of the following:

  • build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
  • ci: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that neither fixes a bug nor adds a feature
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Scope

The following is the list of supported scopes:

  • project_infrastructure
  • readme
  • core_functionality
  • [TBD]

Info

Authors

License

This project is licensed under the MIT License

Acknowledgments