Skip to content

Commit 32e8e25

Browse files
committed
Updated the ReadMe.md and the ChangeLog.
1 parent 612b804 commit 32e8e25

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

CHANGELOG.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
- New feature: You can now generate a markdown(Mermaid) file with the component hierarchy.
66
- Bugfix: The List imports command now also find the require(...) packages.
7-
- Bugfix: ShowComponentHierarchy.html is no longer written to the workspace root.
87

98
## Version 1.0.1
109

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Some of the tools may seem very basic, but can be a powerful help when you have
88

99
* Generate DGML graph of project component hierarchy
1010
* Show the component hierarchy
11+
* Generate a markdown file with the component hierarchy in Mermaid format.
1112
* Show the directory structure of the project
1213
* Generate list of packages used in the project
1314
* List all imports
@@ -34,6 +35,14 @@ You can also choose to save a selection from the graph as shown in the example b
3435

3536
![Show component hierarchy](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/ShowComponentHierarchy2.gif)
3637

38+
### Generate a markdown file with the component hierarchy in Mermaid format [#](#component-hierarchy-markdown- 'Component hierarchy in Mermaid format')
39+
40+
This command will generate the component hierarchy in markdown format using [Mermaid notation](https://mermaid-js.github.io/mermaid/#/).
41+
42+
Please notice that some online tools and sites do not support Mermaid markdown format yet, like GitHub and Visual Studio Code. To preview markdown files using the mermaid notation in Visual Studio Code i'm using the [Markdown Preview Mermaid Support](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid) extension.
43+
44+
![Generate graph in Mermaid notation](https://github.com/CoderAllan/vscode-angulartools/raw/main/images/GenerateMermaid.gif)
45+
3746
### Show the directory structure of the project [#](#directory-structure- 'Show the directory structure of the project')
3847

3948
This command lists the entire directory structure of the currently open project. Sometimes this can be a quick way to get an overview of the project if you are new to the project before og maybe need to document it.
@@ -58,3 +67,4 @@ This command will analyse all Angular components in the project and collect all
5867

5968
* [Vis.js](https://visjs.org/index.html) - Used for generating the directed graph for showing the component hierarchy.
6069
* [npmjs.com](https://www.npmjs.com/) - The extension queries the NpmJs.com api.
70+
* [Mermaid markdown notation](https://mermaid-js.github.io/mermaid/#/)

images/GenerateMermaid.gif

642 KB
Loading

0 commit comments

Comments
 (0)