{"id":16081764,"url":"https://github.com/iolanta-tech/mkdocs-iolanta","last_synced_at":"2025-08-19T04:31:10.933Z","repository":{"id":131786757,"uuid":"600517104","full_name":"iolanta-tech/mkdocs-iolanta","owner":"iolanta-tech","description":"MkDocs plugin to integrate with Iolanta knowledge workspace","archived":false,"fork":false,"pushed_at":"2024-12-07T15:59:37.000Z","size":4517,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-12-07T16:25:12.457Z","etag":null,"topics":["documentation","linked-data","mkdocs","mkdocs-material","owl","python","rdf","sparql"],"latest_commit_sha":null,"homepage":"https://mkdocs.iolanta.tech","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iolanta-tech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-11T18:29:43.000Z","updated_at":"2024-12-07T15:59:39.000Z","dependencies_parsed_at":"2024-12-07T16:33:53.394Z","dependency_job_id":null,"html_url":"https://github.com/iolanta-tech/mkdocs-iolanta","commit_stats":{"total_commits":30,"total_committers":1,"mean_commits":30.0,"dds":0.0,"last_synced_commit":"b0daa32dafd3125e7120ef8cd65bfe0b577bf834"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iolanta-tech%2Fmkdocs-iolanta","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iolanta-tech%2Fmkdocs-iolanta/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iolanta-tech%2Fmkdocs-iolanta/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iolanta-tech%2Fmkdocs-iolanta/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iolanta-tech","download_url":"https://codeload.github.com/iolanta-tech/mkdocs-iolanta/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230316986,"owners_count":18207681,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","linked-data","mkdocs","mkdocs-material","owl","python","rdf","sparql"],"created_at":"2024-10-09T11:09:25.320Z","updated_at":"2024-12-18T17:43:30.035Z","avatar_url":"https://github.com/iolanta-tech.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 📖 [mkdocs](https://mkdocs.org) + 👁️ [iolanta](https://iolanta.tech)\n\n[![License](https://img.shields.io/github/license/iolanta-tech/mkdocs-iolanta)](https://github.com/iolanta-tech/mkdocs-iolanta/blob/main/LICENSE)\n[![Deploy](https://github.com/iolanta-tech/mkdocs-iolanta/actions/workflows/deploy.yml/badge.svg)](https://github.com/iolanta-tech/mkdocs-iolanta/actions)\n[![Stars](https://img.shields.io/github/stars/iolanta-tech/mkdocs-iolanta)](https://github.com/iolanta-tech/mkdocs-iolanta/stargazers)\n[![Forks](https://img.shields.io/github/forks/iolanta-tech/mkdocs-iolanta)](https://github.com/iolanta-tech/mkdocs-iolanta/network/members)\n[![Issues](https://img.shields.io/github/issues/iolanta-tech/mkdocs-iolanta)](https://github.com/iolanta-tech/mkdocs-iolanta/issues)\n[![Pull Requests](https://img.shields.io/github/issues-pr/iolanta-tech/mkdocs-iolanta)](https://github.com/iolanta-tech/mkdocs-iolanta/pulls)\n[![Last Commit](https://img.shields.io/github/last-commit/iolanta-tech/mkdocs-iolanta)](https://github.com/iolanta-tech/mkdocs-iolanta/commits/main)\n[![Contributors](https://img.shields.io/github/contributors/iolanta-tech/mkdocs-iolanta)](https://github.com/iolanta-tech/mkdocs-iolanta/graphs/contributors)\n\n\n![](docs/assets/cover.png)\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 → page [🔗 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 [➕ an issue](https://github.com/iolanta-tech/mkdocs-iolanta/issues)!\n\n## Installation\n\nPython ⩾ 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  - …\n  - iolanta                 # (2)!\n  - macros:                 # (3)!\n      on_error_fail: true   # (4)!\n  - …\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 {% raw %}{{ render(\"render\") }}{% endraw %} 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 — making the issue easier to notice both on local development and in CI.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiolanta-tech%2Fmkdocs-iolanta","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiolanta-tech%2Fmkdocs-iolanta","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiolanta-tech%2Fmkdocs-iolanta/lists"}