{"id":15017181,"url":"https://github.com/mkdocs-publisher/mkdocs-publisher","last_synced_at":"2025-04-04T16:10:07.597Z","repository":{"id":66793573,"uuid":"596628838","full_name":"mkdocs-publisher/mkdocs-publisher","owner":"mkdocs-publisher","description":"Publisher for MkDocs - a set of plugins for content creators","archived":false,"fork":false,"pushed_at":"2025-02-07T11:36:01.000Z","size":7072,"stargazers_count":89,"open_issues_count":9,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-03T11:45:08.210Z","etag":null,"topics":["blog","blogging","callouts","debugger","metadata","minification","mkdocs","mkdocs-plugins","obsidian","obsidian-md","obsidian-vault","publishing","roam-research","roamresearch"],"latest_commit_sha":null,"homepage":"https://mkdocs-publisher.github.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocs-publisher.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["mkdocs-publisher"]}},"created_at":"2023-02-02T15:47:55.000Z","updated_at":"2025-03-25T03:26:32.000Z","dependencies_parsed_at":"2023-10-14T21:02:05.814Z","dependency_job_id":"1c5e5ccf-b625-4ac9-ac36-8b12e01d4754","html_url":"https://github.com/mkdocs-publisher/mkdocs-publisher","commit_stats":{"total_commits":52,"total_committers":2,"mean_commits":26.0,"dds":"0.019230769230769273","last_synced_commit":"862e0b1860afaa2ccb45248fed08f3b5ee36bb36"},"previous_names":["mkusz/mkdocs-blog-in","mkdocs-publisher/mkdocs-publisher"],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs-publisher%2Fmkdocs-publisher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs-publisher%2Fmkdocs-publisher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs-publisher%2Fmkdocs-publisher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs-publisher%2Fmkdocs-publisher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocs-publisher","download_url":"https://codeload.github.com/mkdocs-publisher/mkdocs-publisher/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247005816,"owners_count":20868022,"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":["blog","blogging","callouts","debugger","metadata","minification","mkdocs","mkdocs-plugins","obsidian","obsidian-md","obsidian-vault","publishing","roam-research","roamresearch"],"created_at":"2024-09-24T19:50:00.219Z","updated_at":"2025-04-04T16:10:07.579Z","avatar_url":"https://github.com/mkdocs-publisher.png","language":"Python","funding_links":["https://github.com/sponsors/mkdocs-publisher"],"categories":[],"sub_categories":[],"readme":"# Publisher for MkDocs\n\n[![License type](https://img.shields.io/github/license/mkdocs-publisher/mkdocs-publisher?logo=pypi\u0026logoColor=white\u0026style=plastic\u0026label=License)](https://opensource.org/license/mit/)\n[![PyPI version](https://img.shields.io/pypi/v/mkdocs-publisher?logo=pypi\u0026logoColor=white\u0026style=plastic\u0026label=PyPi)](https://pypi.org/project/mkdocs-publisher/)\n[![PyPI - Python Version](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmkdocs-publisher%2Fmkdocs-publisher%2Fmain%2Fpyproject.toml\u0026query=%24.tool.poetry.dependencies.python\u0026logo=python\u0026logoColor=white\u0026style=plastic\u0026label=Python)](https://www.python.org)\n[![PyPI Downloads last month](https://img.shields.io/pypi/dm/mkdocs-publisher?logo=pypi\u0026logoColor=white\u0026style=plastic\u0026label=Downloads)](https://pypistats.org/search/mkdocs-publisher)\n[![GitHub last commit](https://img.shields.io/github/last-commit/mkdocs-publisher/mkdocs-publisher?logo=github\u0026logoColor=white\u0026style=plastic\u0026label=Last%20commit)](https://github.com/mkusz/mkdocs-publisher/commits/main)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit\u0026logoColor=white\u0026style=plastic\u0026label=Pre-commit)](https://github.com/pre-commit/pre-commit)\n![Code Coverage](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fmkdocs-publisher%2Fmkdocs-publisher%2Fmain%2Fcov.json\u0026query=%24.percent_covered_display\u0026suffix=%25\u0026color=green\u0026style=plastic\u0026label=Code%20coverage)\n\nPublisher for [MkDocs](https://www.mkdocs.org/) is a set of plugins that helps with content creation and publication.\n\n## Features\n\n- [pub-meta](https://mkdocs-publisher.github.io/setup/general/pub-meta/) – support for:\n\t- automatic [document navigation](https://www.mkdocs.org/user-guide/configuration/#nav) creation based on file names order,\n\t- document publication status,\n\t- possibility to define document and directories URL (good for SEO),\n\t- document creation and update date (good for SEO),\n- [pub-blog](https://mkdocs-publisher.github.io/setup/general/pub-blog/) – blogging capability:\n\t- index creation,\n\t- support for blog post teasers,\n\t- automatic creation of pages for archive, categories and tags,\n- [pub-obsidian](https://mkdocs-publisher.github.io/setup/general/pub-obsidian/) – bindings for [Obsidian.md](https://obsidian.md) that allows you to use:\n\t- [backlinks](https://help.obsidian.md/Plugins/Backlinks),\n\t- [callouts](https://help.obsidian.md/Editing+and+formatting/Callouts),\n\t- [wikilinks](https://help.obsidian.md/Linking+notes+and+files/Internal+links),\n\t- [vega charts](https://vega.github.io/vega/) (using [Vega Visualization Plugin for Obsidian](https://github.com/Some-Regular-Person/obsidian-vega)) - advanced solution for creating charts,\n- [pub-social](https://mkdocs-publisher.github.io/setup/seo-and-sharing/pub-social/) – social cards for social media sharing using document metadata,\n- [pub-minifier](https://mkdocs-publisher.github.io/setup/seo-and-sharing/pub-minifier/) – file size optimization (good for SEO and overall page size optimization),\n- [pub-debugger](https://mkdocs-publisher.github.io/setup/development/pub-debugger/) – logging on steroids with the possibility of creating of ZIP file with logs and additional information (can be used for better issue reporting).\n\n## Installation\n\n```commandline\npip install mkdocs-publisher\n```\n\nMore information about installation methods and plugin setup can be found on this [documentation page](https://mkdocs-publisher.github.io/setup/installation/).\n\n\u003e [!warning]\n\u003e Before any use, make sure you have a backup of your data.\n\n\u003e [!note]\n\u003e As a base for any development, [mkdocs-material](https://squidfunk.github.io/mkdocs-material/) theme was used. If you are willing to use any other theme, you may (or may not) face some issues. If this happens, please submit an [issue](https://github.com/mkdocs-publisher/mkdocs-publisher/issues).\n\nAfter installation, you have to enable plugins and Material for MkDocs theme in `mkdocs.yml` file:\n\n```yaml\ntheme: material\n\nplugins:\n  - search  # Material for MkDocs search plugin\n  - pub-debugger\n  - pub-blog\n  - pub-obsidian\n  - pub-social\n  - pub-meta\n  - pub-minifier\n```\n\n## Planned features\n\nA full list of planned developments can be found on [this documentation page](https://mkdocs-publisher.github.io/development/other/backlog/). I'm planning to move it to the project [GitHub issues](https://github.com/mkusz/mkdocs-publisher/issues) with proper badges and longer descriptions, but it's time-consuming and at this stage I'd rather spend it developing a project.\n\n## Version history\n\nThe entire version history can be found in the project [version history](https://mkdocs-publisher.github.io/development/changelog/) document and inside [releases](https://github.com/mkusz/mkdocs-publisher/releases).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs-publisher%2Fmkdocs-publisher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocs-publisher%2Fmkdocs-publisher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs-publisher%2Fmkdocs-publisher/lists"}