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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
