Skip to content

Commit

Permalink
Add changelog file
Browse files Browse the repository at this point in the history
  - Little correction of module HTML call, in documentation
  • Loading branch information
Laurent Franceschetti committed Jul 29, 2023
1 parent 2be83d0 commit 1308248
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 3 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Changelog: mkdocs-macros

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).


## 1.0.5, 2023-07-29

Added: A new [doc website is available on Read The Docs](https://mkdocs-mermaid2.readthedocs.io/en/latest/).

## 1.0.1, 2023-07

Added: Now the plugin works with versions of the library > 10 and lower (#75)
Added: Added: A new [doc website is available on Read The Docs](https://mkdocs-mermaid2.readthedocs.io/en/latest/).
6 changes: 3 additions & 3 deletions webdoc/docs/description.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ of Mermaid.js required:
[For versions from 10.0.0 of the Mermaid javascript library, the plugin uses the ESM format](https://github.com/mermaid-js/mermaid/releases/tag/v10.0.0), since
it is the only one available. This requires a specific call from the HTML
page e.g.:
``` html
<script type="module">
import mermaid from "https://unpkg.com/mermaid@10.0.2/dist/mermaid.esm.min.mjs"
<script src="https://unpkg.com/mermaid@10.0.2/dist/mermaid.esm.min.mjs" type="module">
</script>
```


The plugin automatically inserts this call.

=== "Earlier versions"
Expand Down

0 comments on commit 1308248

Please sign in to comment.