| Name | mkdocs-iolanta JSON |
| Version |
0.1.7
JSON |
| download |
| home_page | |
| Summary | MkDocs plugin to integrate with Iolanta semantic web framework. |
| upload_time | 2023-10-21 13:17:50 |
| maintainer | |
| docs_url | None |
| author | Anatoly Scherbakov |
| requires_python | >=3.10,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 📖 [mkdocs](https://mkdocs.org) + 👁️ [iolanta](https://iolanta.tech)
[](https://github.com/iolanta-tech/mkdocs-iolanta/blob/main/LICENSE)
[](https://github.com/iolanta-tech/mkdocs-iolanta/actions)
[](https://github.com/iolanta-tech/mkdocs-iolanta/stargazers)
[](https://github.com/iolanta-tech/mkdocs-iolanta/network/members)
[](https://github.com/iolanta-tech/mkdocs-iolanta/issues)
[](https://github.com/iolanta-tech/mkdocs-iolanta/pulls)
[](https://github.com/iolanta-tech/mkdocs-iolanta/commits/main)
[](https://github.com/iolanta-tech/mkdocs-iolanta/graphs/contributors)
## Features
By integrating MkDocs static site builder with Iolanta knowledge management workspace, you can empower your static site with:
* Automatic page → page [🔗 links](https://mkdocs.iolanta.tech/link/);
* [Tables](https://tables.iolanta.tech) generated from YAML data;
* Project [roadmaps](https://roadmap.iolanta.tech);
* [Architecture Decision Records](https://adr.iolanta.tech).
* Something missing? Or anything doesn't work? Submit [➕ an issue](https://github.com/iolanta-tech/mkdocs-iolanta/issues)!
## Installation
Python ⩾ 3.10 required.
`mkdocs-iolanta` is on [PyPI](https://pypi.org/project/mkdocs-iolanta).
```bash
pip install mkdocs-iolanta
```
## Configuration
Open your `mkdocs.yml` configuration file and configure its `plugins` section as follows:
```yaml
plugins:
- search # (1)!
- …
- iolanta # (2)!
- macros: # (3)!
on_error_fail: true # (4)!
- …
```
1. The `search` plugin is built-in and automatically enabled if `mkdocs.yml` does not specify any `plugins` at all. But if it does, this built-in plugin must be enabled explicitly.
2. Support `iolanta` capabilities for this documentation site.
3. This enables [mkdocs-macros-plugin](https://mkdocs-macros-plugin.readthedocs.io) which is required to utilize Iolanta capabilities on MkDocs pages, such as {{ render("render") }} macro.
4. This setting is highly recommended. If there is an error during rendering MkDocs macros, including those macros provided by Iolanta, the site build will throw an error — making the issue easier to notice both on local development and in CI.
Raw data
{
"_id": null,
"home_page": "",
"name": "mkdocs-iolanta",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Anatoly Scherbakov",
"author_email": "altaisoft@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/17/27/0b5af1a19721c467c2a5ef58a7786ba92c764187c968bb0eab22209f8904/mkdocs_iolanta-0.1.7.tar.gz",
"platform": null,
"description": "# \ud83d\udcd6 [mkdocs](https://mkdocs.org) + \ud83d\udc41\ufe0f [iolanta](https://iolanta.tech)\n\n[](https://github.com/iolanta-tech/mkdocs-iolanta/blob/main/LICENSE)\n[](https://github.com/iolanta-tech/mkdocs-iolanta/actions)\n[](https://github.com/iolanta-tech/mkdocs-iolanta/stargazers)\n[](https://github.com/iolanta-tech/mkdocs-iolanta/network/members)\n[](https://github.com/iolanta-tech/mkdocs-iolanta/issues)\n[](https://github.com/iolanta-tech/mkdocs-iolanta/pulls)\n[](https://github.com/iolanta-tech/mkdocs-iolanta/commits/main)\n[](https://github.com/iolanta-tech/mkdocs-iolanta/graphs/contributors)\n\n\n\n\n## Features\n\nBy integrating MkDocs static site builder with Iolanta knowledge management workspace, you can empower your static site with:\n\n* Automatic page \u2192 page [\ud83d\udd17 links](https://mkdocs.iolanta.tech/link/);\n* [Tables](https://tables.iolanta.tech) generated from YAML data;\n* Project [roadmaps](https://roadmap.iolanta.tech);\n* [Architecture Decision Records](https://adr.iolanta.tech).\n* Something missing? Or anything doesn't work? Submit [\u2795 an issue](https://github.com/iolanta-tech/mkdocs-iolanta/issues)!\n\n## Installation\n\nPython \u2a7e 3.10 required.\n\n`mkdocs-iolanta` is on [PyPI](https://pypi.org/project/mkdocs-iolanta).\n\n```bash\npip install mkdocs-iolanta\n```\n\n## Configuration\n\nOpen your `mkdocs.yml` configuration file and configure its `plugins` section as follows:\n\n```yaml\nplugins:\n - search # (1)!\n - \u2026\n - iolanta # (2)!\n - macros: # (3)!\n on_error_fail: true # (4)!\n - \u2026\n```\n\n1. The `search` plugin is built-in and automatically enabled if `mkdocs.yml` does not specify any `plugins` at all. But if it does, this built-in plugin must be enabled explicitly.\n2. Support `iolanta` capabilities for this documentation site.\n3. This enables [mkdocs-macros-plugin](https://mkdocs-macros-plugin.readthedocs.io) which is required to utilize Iolanta capabilities on MkDocs pages, such as {{ render(\"render\") }} macro.\n4. This setting is highly recommended. If there is an error during rendering MkDocs macros, including those macros provided by Iolanta, the site build will throw an error \u2014 making the issue easier to notice both on local development and in CI.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MkDocs plugin to integrate with Iolanta semantic web framework.",
"version": "0.1.7",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b7dd2d3faa0760e822d5b2c5e8831160992420e0df0009ab7e5427aeff4219b",
"md5": "1008ab76b111ddcdbfa550b2223c8f36",
"sha256": "034febce1d7898182fed475ddc8e06f7b07bb24e1ada109a523deebaee23d1f3"
},
"downloads": -1,
"filename": "mkdocs_iolanta-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1008ab76b111ddcdbfa550b2223c8f36",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10,<4.0",
"size": 37590,
"upload_time": "2023-10-21T13:17:48",
"upload_time_iso_8601": "2023-10-21T13:17:48.271510Z",
"url": "https://files.pythonhosted.org/packages/9b/7d/d2d3faa0760e822d5b2c5e8831160992420e0df0009ab7e5427aeff4219b/mkdocs_iolanta-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "17270b5af1a19721c467c2a5ef58a7786ba92c764187c968bb0eab22209f8904",
"md5": "adf95f4207ccf8774b32b3c2ad238f07",
"sha256": "e94a44ae070d3a0102412a2d0c361d47f1109baa0cae4eea10f6712ebacef82f"
},
"downloads": -1,
"filename": "mkdocs_iolanta-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "adf95f4207ccf8774b32b3c2ad238f07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10,<4.0",
"size": 32630,
"upload_time": "2023-10-21T13:17:50",
"upload_time_iso_8601": "2023-10-21T13:17:50.108082Z",
"url": "https://files.pythonhosted.org/packages/17/27/0b5af1a19721c467c2a5ef58a7786ba92c764187c968bb0eab22209f8904/mkdocs_iolanta-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-21 13:17:50",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "mkdocs-iolanta"
}
