You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "kwin (via GitHub)" <gi...@apache.org> on 2026/05/18 18:40:25 UTC
[PR] Document Mermaid Diagram Support [maven-doxia-sitetools]
kwin opened a new pull request, #650:
URL: https://github.com/apache/maven-doxia-sitetools/pull/650
WIP
Requires newer m-site-p
Following this checklist to help us incorporate your
contribution quickly and easily:
- [ ] Your pull request should address just one issue, without pulling in other changes.
- [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
- [ ] Each commit in the pull request should have a meaningful subject line and body.
Note that commits might be squashed by a maintainer on merge.
- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
This may not always be possible but is a best-practice.
- [ ] Run `mvn verify` to make sure basic checks pass.
A more thorough check will be performed on your pull request automatically.
- [ ] You have run the integration tests successfully (`mvn -Prun-its verify`).
If your pull request is about ~20 lines of code you don't need to sign an
[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
you have to acknowledge this by using the following check-box.
- [ ] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
- [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Document Mermaid Diagram Support [maven-doxia-sitetools]
Posted by "kwin (via GitHub)" <gi...@apache.org>.
kwin commented on code in PR #650:
URL: https://github.com/apache/maven-doxia-sitetools/pull/650#discussion_r3261206471
##########
doxia-site-renderer/src/site/markdown/mermaid-diagrams.md:
##########
@@ -0,0 +1,103 @@
+---
+title: Mermaid Diagrams
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+
+<!-- MACRO{toc} -->
+
+# Mermaid Diagrams
+
+Doxia Sitetools can optionally embed the necessary Javascript to render [Mermaid](https://mermaid.ai/open-source/) diagrams client-side (supported since [2.1.0](https://github.com/apache/maven-doxia-sitetools/issues/611).
Review Comment:
missing closing `)`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Document Mermaid Diagram Support [maven-doxia-sitetools]
Posted by "kwin (via GitHub)" <gi...@apache.org>.
kwin merged PR #650:
URL: https://github.com/apache/maven-doxia-sitetools/pull/650
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Document Mermaid Diagram Support [maven-doxia-sitetools]
Posted by "kwin (via GitHub)" <gi...@apache.org>.
kwin commented on code in PR #650:
URL: https://github.com/apache/maven-doxia-sitetools/pull/650#discussion_r3261210198
##########
doxia-site-renderer/src/site/markdown/mermaid-diagrams.md:
##########
@@ -0,0 +1,103 @@
+---
+title: Mermaid Diagrams
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+
+<!-- MACRO{toc} -->
+
+# Mermaid Diagrams
+
+Doxia Sitetools can optionally embed the necessary Javascript to render [Mermaid](https://mermaid.ai/open-source/) diagrams client-side (supported since [2.1.0](https://github.com/apache/maven-doxia-sitetools/issues/611).
+
+# Setup
+
+In order to enable this feature one has to [add element `mermaid` to the Site Descriptor](../doxia-site-model/site.html#mermaid).
Review Comment:
lower case `site descriptor`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Document Mermaid Diagram Support [maven-doxia-sitetools]
Posted by "michael-o (via GitHub)" <gi...@apache.org>.
michael-o commented on code in PR #650:
URL: https://github.com/apache/maven-doxia-sitetools/pull/650#discussion_r3369113432
##########
doxia-site-renderer/src/site/markdown/mermaid-diagrams.md:
##########
@@ -0,0 +1,102 @@
+---
+title: Mermaid Diagrams
+---
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one-->
+<!-- or more contributor license agreements. See the NOTICE file-->
+<!-- distributed with this work for additional information-->
+<!-- regarding copyright ownership. The ASF licenses this file-->
+<!-- to you under the Apache License, Version 2.0 (the-->
+<!-- "License"); you may not use this file except in compliance-->
+<!-- with the License. You may obtain a copy of the License at-->
+<!---->
+<!-- http://www.apache.org/licenses/LICENSE-2.0-->
+<!---->
+<!-- Unless required by applicable law or agreed to in writing,-->
+<!-- software distributed under the License is distributed on an-->
+<!-- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY-->
+<!-- KIND, either express or implied. See the License for the-->
+<!-- specific language governing permissions and limitations-->
+<!-- under the License.-->
+
+
+# Mermaid Diagrams
+
+Doxia Sitetools can optionally embed the necessary Javascript to render [Mermaid](https://mermaid.ai/open-source/) diagrams client-side (supported since [2.1.0](https://github.com/apache/maven-doxia-sitetools/issues/611)).
Review Comment:
JavaScript
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org