Article
· Feb 5, 2023 1m read

See your class catalog with mindmaps and markdown

 

If you want to know more about a new project or generate a new way to see your project, the better way is using mindmaps or markdown documentation. The IRIS Connections allows to you generate the mindmap for your classes and get your classes documentation in a markdown file.

 

IRIS Connections installation

If you want to install using ZPM:

zpm:USER>install iris-connections

If you want to install using Docker:

1. Clone/git pull the repo into any local directory:

$ git clone https://github.com/yurimarx/iris-connections.git

2. Open the terminal in this directory and run:

$ docker-compose up -d --build

See the mindmap of your source code:

Go to your browser and access:

localhost:52773/connections/index.html  

No go to Mindmap and see your classes mindmap:

See the markdown of your source code:

To see the markdown for your all source code, go to Mindmap menu, and go to the tab Markdown class documentation.

Now you can see your class inventory in markdown (left), in HTML (right) and in a mindmap (tab class mindmap).

Enjoy!

Discussion (0)1
Log in or sign up to continue