From c43b458929bd110fd2b16925e8d09b0046076b65 Mon Sep 17 00:00:00 2001 From: Holger Schmidt Date: Fri, 8 Nov 2024 21:24:32 +0100 Subject: [PATCH] added developer-facing doco for how to edit the HTML/JS/CSS parts --- ICSharpCode.ILSpyX/MermaidDiagrammer/html/README.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 ICSharpCode.ILSpyX/MermaidDiagrammer/html/README.txt diff --git a/ICSharpCode.ILSpyX/MermaidDiagrammer/html/README.txt b/ICSharpCode.ILSpyX/MermaidDiagrammer/html/README.txt new file mode 100644 index 000000000..7a668d544 --- /dev/null +++ b/ICSharpCode.ILSpyX/MermaidDiagrammer/html/README.txt @@ -0,0 +1,10 @@ +To edit the HTML/JS/CSS for the HTML diagrammer, open this folder in Visual Studio Code. + +In that environment 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. \ No newline at end of file