Skip to content

Commit

Permalink
added developer-facing doco for how to edit the HTML/JS/CSS parts
Browse files Browse the repository at this point in the history
  • Loading branch information
h0lg committed Nov 8, 2024
1 parent 37b5604 commit f40934c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions ICSharpCode.ILSpyX/MermaidDiagrammer/html/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
To edit the HTML/JS/CSS for the HTML diagrammer, open this folder in Visual Studio Code.

There you'll find tasks (see https://code.visualstudio.com/Docs/editor/tasks to run and configure)
that you can run to

1. Generate a model.json using the current Debug build of ilspycmd.
This is required to build a diagrammer for testing in development using task 3.
2. Transpile the .less into .css that is tracked by source control and embedded into ILSpyX.
3. Generate a diagrammer for testing in development from template.html and the model.json generated by task 1.
4. Auto-rebuild the development diagrammer by running either task 2 or 3 when the corresponding source files change.

0 comments on commit f40934c

Please sign in to comment.