structurizr / import Goto Github PK
View Code? Open in Web Editor NEWUtilities to import diagrams and documentation into a Structurizr workspace
License: Apache License 2.0
Utilities to import diagrams and documentation into a Structurizr workspace
License: Apache License 2.0
I would like to use Asciidoc for all of my documentation and ADR files. But if I make ADRs in the Asciidoc format they don't work. They either don't show up if the file-extensions is .adoc or the Asciidoc markup is ignored when I use the .md file-extension.
When I use Markdown markup with the .md extension everything works correctly.
I'm using the .war version, build 2828.
When using the DefaultDocumentationImporter it is not possible to import a folder structure like this:
docs
01-introduction-and-goals
01-introduction-and-goals.md
someAsset.png
anotherAsset.png
DefaultDocumentationImporter
requires the files to be in the same (flat) directory.
I'd like to be able to group assets referenced in a documentation chapter in a folder next to the actual document. This would also enable advanced workflows on Git level (e.g. define a chapter (=folder) owner as default reviewer if a given folder path was changed).
Support recursive documentation import in the default importer.
With Structurizr documentation supporting asciidoc, it would be nice if the Adrs also supported this format.
The DSL Language reference states that this is supported, but it seems that a custom class would need to be created.
The !adrs keyword can be used to attach Markdown/AsciiDoc ADRs to the parent context (either the workspace, a software system, or a container).
Low
I have no budget and there's no rush, please add this feature for free
No response
[Foo](images/foo.svg)
embed svg with above syntax was not supported, in Documentation or Decisions page.
Can we embed SVG using the same approach as PNG images?
Something like convert them to base64 string:
<img alt="" src="data:image/svg+xml;base64,PHN2ZyBob3N0PS...+" />
[Foo](images/foo.svg)
No response
No response
No response
Minor
Low
I have no budget, please fix this for free
No response
The mermaid.ink url generated by Structurizr lite is incorrectly encoded and does not work. Suppose I want to include this basic mermaid diagram in an image view:
flowchart TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]
flowchart TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]
I can see my web browser attempts a get request to this url to get the image but it fails with the message "invalid encoded code".
After fiddling around a bit, I found using this technique to encode the diagram worked:
mermaid_content = """
flowchart TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]
"""
encoded_mermaid_content = base64.urlsafe_b64encode(mermaid_content.encode('utf-8')).decode('utf-8')
It produces this working url which successfully generates the diagram:
I'm using the latest structurizr lite docker image.
No response
No response
No response
Minor
Low
I have no budget and there's no rush, please fix this for free
No response
The image importer is importing images from the .structurizr
folder in Structurizr Lite, and should probably ignore hidden folders.
If my title is, for example, "Node.js for Runtime" I get "S for Runtime". Fixed when I remove ".". Escaping the period makes no difference.
When creating an ADR with a specific date in the Markdown file, I expect the same date to show up when rendered in Structurizr Lite's Decisions views. However, the date shown is one day earlier.
Please excuse the odd numeric sequencing. I'm creating these ADRs retroactively, and not necessarily in chronological order.
No response
No response
Minor
Low
I have no budget, please fix this for free
No response
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.