Script to convert a remote QRC (Qt Resources Collection files) into a markdown table to preview images.
This project covers QGIS project and generates a cheatsheet published on https://geotribu.github.io/pyqgis-icons-cheatsheet/.
Author: Julien M. (:octopus: Guts on GitHub, 🐦 GeoJulien on Twitter) for Geotribu collaborative website.
Code under MIT license.
Content and methodolgy under Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).
Website icon by Arunmozhi, CC BY-SA 4.0 https://creativecommons.org/licenses/by-sa/4.0, via Wikimedia Commons.
There is also a plugin that allow to browse resources right into QGIS. Don't miss it!
demo_qgis_plugin_resource_browser.webm
- blog posts/tutorials (in French 🇫🇷):
- resources file in QGIS project: https://github.com/qgis/QGIS/blob/master/images/images.qrc
- Qt documentation: https://doc.qt.io/qt-5/resources.html
-
Python 3.10+
-
network connection authorized to github.com
-
Material for Mkdocs Insiders (sponsorware) token set as environment variable
GH_TOKEN_MATERIAL_INSIDERS -
dependencies for images processing listed on theme documentation. Typically, on Ubuntu:
sudo apt install libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev pngquant
Typically on Ubuntu:
python3 -m venv .venv
source .venv/bin/activate
python -m pip install -U pip setuptools wheel
python -m pip install -U -r requirements.txt
pre-commit installRun the script:
python qrc_preview_in_md.pyThe output markdown page is located at docs/index.md, overriding the version pushed as project has been started.
Copy the README.MD into the docs folder:
cp README.md docs/credits.mdBuild:
mkdocs buildServe locally:
mkdocs serveOpen your browser on: http://localhost:8000
The website is monthly regenerated and deployed on GitHub Pages using GitHub Actions. For more details, see the deploy.yml workflow.