Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/Include PlantUML diagrams at arbitrary positions in doc #28

Closed

Conversation

sju66
Copy link

@sju66 sju66 commented Oct 22, 2020

Addition of the possibility of including diagrams at an arbitrary position via the use of markdown syntax ![](_diagram.puml).

Fixes #21

@adrianvlupu
Copy link
Owner

Thanks for the pull request, I'll come back to this after I push all the other PRs

@hkdobrev
Copy link
Contributor

@adrianvlupu Is it possible to review this at this time? Thank you!

@MickeJohannesson
Copy link
Contributor

MickeJohannesson commented Feb 22, 2022

I have done an update to this PR but not able to commit it.
Changes made:

  • Added support to add an PUML diagram in the page in format ! [name] (name.puml) and it will be excluded from the normal rendering of the page. All other will be in top/bottom
  • Merged from latest master and fixed the merge problems.
  • Removed the extra config settings added in this PR, instead use current one (PLANTUML_SERVER_URL)
  • Updated with latest PlantUML (plantuml-1.2022.1.jar)
  • Updated some NPMs: md-to-pdf and joi
  • Fixed "Download link" in deep folder structures (had problem on level 3 where it lost subfolders)
  • Added "new line" on Download link/Go to link (before they came next to the diagram instead of under it)
  • Added support for DITAA diagram type (only PNG is supported)

If someone could give me a hint on getting this into this PR or if I need to push it as a new PR

@huyz
Copy link

huyz commented Mar 7, 2022

@MickeJohannesson Your changes look quite useful. But they seem like multiple PRs. Can you break it up and submit PRs separately?

@MickeJohannesson
Copy link
Contributor

The problem is that all changes (more or less) are made in the build.js file. And I have done them in the version from this PR.
Some are of course not needed (like PlantUML and NPM update).
But to make for example DITAA support work it can not be separated in the main version of the build.js in a simple way
What I instead could do is do a first commit on a new PR and then commit the "addons" as separate commits.

@vellala2000
Copy link

vellala2000 commented Mar 22, 2022

This seems like very handy feature and its pending for some time. If we could figure out conflicts and a path forward that would be awesome. Please let me know if there is anything i can do to help

@adrianvlupu
Copy link
Owner

Thanks for the implementation.

I couldn't merge it properly but the functionality is there from another PR (that included your changes) and my refactoring.

You can include diagrams using ![name](diagramName.puml) where diagramName is variable.

@sju66 sju66 deleted the feature/plantuml_arbitrary_position branch March 8, 2023 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide option to include PlantUML diagrams at arbitrary positions in doc
8 participants