Skip to content

Commit 6f42aa0

Browse files
authored
Update README.md
added limitations section
1 parent ae4527c commit 6f42aa0

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,14 @@ Beginning from version `0.3.0` the default graph inside the sidebar was minimize
3737
# Docker
3838
Adapt the `.env` and `mkdocs.yml` files to your needs. `DEV=ON` will rebuild the `mkdocs-obsidian-interactive-graph-plugin` from local files. If `DEV != ON` the upstream packages of PyPI will be used. Build and start the Docker container via `docker compose up --build [-d]`.
3939

40+
# Limitations
41+
There is a bug in ECharts library in pinch to zoom feature (https://github.com/apache/echarts/pull/21068), but it seems like they will not fix it. Anybody can fix it by its own, by downloading the current version of the javascript library and patching via diff of the pull-request and use this in the mkdocs configuration. May another good idea could be, to not use the ECharts library... There is another project like this, that uses D3 library instead of ECharts: https://github.com/develmusa/mkdocs-network-graph-plugin including some more improvements.
42+
4043
# References
4144
* https://www.mkdocs.org/
4245
* https://squidfunk.github.io/mkdocs-material/
4346
* https://github.com/ndy2/mkdocs-obsidian-support-plugin/tree/main
4447
* https://github.com/GooRoo/mkdocs-obsidian-bridge
4548
* https://github.com/blueswen/mkdocs-glightbox
4649
* https://echarts.apache.org
50+
* https://github.com/mkdocs/catalog

0 commit comments

Comments
 (0)