| Name | mkdocs-glightbox-tables JSON |
| Version |
0.2.4
JSON |
| download |
| home_page | |
| Summary | MkDocs plugin supports image and table lightbox with GLightbox. |
| upload_time | 2024-03-05 18:31:08 |
| maintainer | |
| docs_url | None |
| author | ThomasPJ |
| requires_python | |
| license | MIT |
| keywords |
mkdocs
plugin
lightbox
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MkDocs GLightbox
[](https://pypi.org/project/mkdocs-glightbox)
[](https://pypi.org/project/mkdocs-glightbox)
A MkDocs plugin supports image lightbox with [GLightbox](https://github.com/biati-digital/glightbox).
GLightbox is a pure javascript lightbox library with mobile support.
[Live demo](https://blueswen.github.io/mkdocs-glightbox/) with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
## Dependency
1. Python Package
1. beautifulsoup4>=4.11.1
2. GLightbox javascript file and css file
1. GLightbox==3.2.0
## Usage
1. Install plugin from pypi
```bash
pip install mkdocs-glightbox
```
2. Add ```glightbox``` plugin to your mkdocs.yml plugins sections:
```yaml
plugins:
- glightbox
```
3. You may customize the plugin by passing options in mkdocs.yml:
```yaml
plugins:
- glightbox:
touchNavigation: true
loop: false
effect: zoom
width: 100%
height: auto
zoomable: true
draggable: true
```
| Option | Default | Description |
|-----------------|---------|--------------------------------------------------------------------------------------------------------------|
| touchNavigation | true | Enable or disable the touch navigation (swipe). |
| loop | false | Loop slides on end. |
| effect | zoom | Name of the effect on lightbox open. (zoom, fade, none) |
| width | 100% | Default width for inline elements and iframes. You can use any unit for example 90% or 100vw for full width. |
| height | auto | Default height for inline elements and iframes. You can use any unit for example 90%, 100vh or auto. |
| zoomable | true | Enable or disable zoomable images. |
| draggable | true | Enable or disable mouse drag to go prev and next slide. |
Check more options information on [GLightbox Docs](https://github.com/biati-digital/glightbox#lightbox-options).
4. For more flexibility, you can disable lightbox by a [specific image](https://blueswen.github.io/mkdocs-glightbox/disable/image) or a [specific page](https://blueswen.github.io/mkdocs-glightbox/disable/page).
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/Blueswen/mkdocs-glightbox/blob/main/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-glightbox-tables",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mkdocs,plugin,lightbox",
"author": "ThomasPJ",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/d7/ed/e8655c0d3119ffb1ceb0803d2a7a6a43a131554a35418e488b381f2a3fb7/mkdocs-glightbox-tables-0.2.4.tar.gz",
"platform": null,
"description": "# MkDocs GLightbox \n\n[](https://pypi.org/project/mkdocs-glightbox)\n[](https://pypi.org/project/mkdocs-glightbox)\n\nA MkDocs plugin supports image lightbox with [GLightbox](https://github.com/biati-digital/glightbox).\n\nGLightbox is a pure javascript lightbox library with mobile support.\n\n[Live demo](https://blueswen.github.io/mkdocs-glightbox/) with [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).\n\n## Dependency\n\n1. Python Package\n 1. beautifulsoup4>=4.11.1\n2. GLightbox javascript file and css file\n 1. GLightbox==3.2.0\n\n## Usage\n\n1. Install plugin from pypi\n\n ```bash\n pip install mkdocs-glightbox\n ```\n\n2. Add ```glightbox``` plugin to your mkdocs.yml plugins sections:\n\n ```yaml\n plugins:\n - glightbox\n ```\n\n3. You may customize the plugin by passing options in mkdocs.yml:\n\n ```yaml\n plugins:\n - glightbox:\n touchNavigation: true\n loop: false\n effect: zoom\n width: 100%\n height: auto\n zoomable: true\n draggable: true\n ```\n\n | Option | Default | Description |\n |-----------------|---------|--------------------------------------------------------------------------------------------------------------|\n | touchNavigation | true | Enable or disable the touch navigation (swipe). |\n | loop | false | Loop slides on end. |\n | effect | zoom | Name of the effect on lightbox open. (zoom, fade, none) |\n | width | 100% | Default width for inline elements and iframes. You can use any unit for example 90% or 100vw for full width. |\n | height | auto | Default height for inline elements and iframes. You can use any unit for example 90%, 100vh or auto. |\n | zoomable | true | Enable or disable zoomable images. |\n | draggable | true | Enable or disable mouse drag to go prev and next slide. |\n\n Check more options information on [GLightbox Docs](https://github.com/biati-digital/glightbox#lightbox-options).\n\n4. For more flexibility, you can disable lightbox by a [specific image](https://blueswen.github.io/mkdocs-glightbox/disable/image) or a [specific page](https://blueswen.github.io/mkdocs-glightbox/disable/page).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](https://github.com/Blueswen/mkdocs-glightbox/blob/main/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs plugin supports image and table lightbox with GLightbox.",
"version": "0.2.4",
"project_urls": null,
"split_keywords": [
"mkdocs",
"plugin",
"lightbox"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d7ede8655c0d3119ffb1ceb0803d2a7a6a43a131554a35418e488b381f2a3fb7",
"md5": "1ec57de812d30166874233f154f1c389",
"sha256": "086f9d7763a77fef362d82d95403f3cef11675836881facadb5d6faad285c03d"
},
"downloads": -1,
"filename": "mkdocs-glightbox-tables-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "1ec57de812d30166874233f154f1c389",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24303,
"upload_time": "2024-03-05T18:31:08",
"upload_time_iso_8601": "2024-03-05T18:31:08.937461Z",
"url": "https://files.pythonhosted.org/packages/d7/ed/e8655c0d3119ffb1ceb0803d2a7a6a43a131554a35418e488b381f2a3fb7/mkdocs-glightbox-tables-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 18:31:08",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mkdocs-glightbox-tables"
}
