{"id":15596614,"url":"https://github.com/derjd/python-mkblog","last_synced_at":"2025-04-12T12:20:25.936Z","repository":{"id":57442076,"uuid":"349420983","full_name":"derJD/python-mkblog","owner":"derJD","description":"This is a MkDocs Plugin adding basic blogging functionality by parsing a `blog` directory ontop of your usual `docs` directory.","archived":false,"fork":false,"pushed_at":"2021-04-14T14:46:30.000Z","size":110,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-26T07:03:14.475Z","etag":null,"topics":["blogging","mkdocs","mkdocs-material","mkdocs-plugin"],"latest_commit_sha":null,"homepage":"https://der-jd.de/python-mkblog/intro/","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/derJD.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-03-19T12:48:35.000Z","updated_at":"2023-11-23T00:46:22.000Z","dependencies_parsed_at":"2022-09-26T17:21:06.661Z","dependency_job_id":null,"html_url":"https://github.com/derJD/python-mkblog","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derJD%2Fpython-mkblog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derJD%2Fpython-mkblog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derJD%2Fpython-mkblog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/derJD%2Fpython-mkblog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/derJD","download_url":"https://codeload.github.com/derJD/python-mkblog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248565179,"owners_count":21125435,"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":["blogging","mkdocs","mkdocs-material","mkdocs-plugin"],"created_at":"2024-10-03T01:05:40.276Z","updated_at":"2025-04-12T12:20:25.908Z","avatar_url":"https://github.com/derJD.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# python-mkblog\n\n[![PyPI version](https://badge.fury.io/py/mkblog.svg)](https://badge.fury.io/py/mkblog)\n[![PyPI downloads](https://img.shields.io/pypi/dm/mkblog)](https://pypi.org/project/mkblog/)\n[![pylint](https://gitlab.der-jd.de/python/mkblog/-/jobs/artifacts/main/raw/pylint.svg?job=lint:pylint)](#python-mkblog)\n\nThis is yet another MkDocs plugin adding basic blogging functionality.\nWith this plugin you store your blogposts in a separate `blog` directory.\n\n![example tree](/img/mkblog_example_tree.jpg)\n\nAs you can see it doesn't matter how you store your posts in the `blog` directory.\nInstead of directory structures, this plugin relies on markdown Metadata `date`.\n\n![example page](/img/mkblog_example_page.jpg)\n\nUse this plugin alongside with the plugin [awesome-pages](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin).\n`awesome-pages` will take care of generating the whole nav bar, so you (or this blog plugin) don't have to do it.\n\n## Features\n\n* Extra directory for your blog posts\n* Utilizing markdown meta `date`\n* No need for date directories and subdirectories and sub sub directories\n\n## Installation\n\n* from pypi: `pip install python-mkblog`\n* from github: `pip install git+https://github.com./derJD/python-mkblog.git`\n\n### Local Build\n\n```sh\ngit clone https://github.com/derJD/python-mkblog.git\ncd python-mkblog\npip install .\n```\n\n## Usage\n\nThere is an complete [example](/example/) directory.\nTake a look by cloning this repository and issuing `mkdocs serve -f example/mkdocs.yml`\n\n**Most basic example `mkdocs.yml`**:\n\n```yaml\n---\n\nsite_name: basic test page\n\nplugins:\n  - awesome-pages\n  - mkblog\n\n```\n\n**This example uses `material theme` to make the site prettier and it uses `discus extra` to give people the opportunity to leave a comment**:\n\n```yaml\n---\n\nsite_name: test page with comments\n\ntheme:\n  name: material\n  features:\n    - tabs\n  palette:\n    primary: green\n    accent: yellow\n\nplugins:\n  - mkblog\n  - search\n  - awesome-pages\n\nextra:\n  disqus: \u003cYOUR DISQUS TOKEN\u003e\n\n```\n\n**You can configure the name of your blog directory**:\n\n```yaml\n---\n\nplugins:\n  - mkblog:\n      blog_dir: bloggiemcblogger\n\n```\n\n## Documentation\n\n* [General documentation](https://der-jd.de/python-mkblog/intro/)\n* [Reference](https://der-jd.de/python-mkblog/reference/mkblog/)\n\n## License\n\n* Code released under [MIT License](https://opensource.org/licenses/MIT)\n\n## Author\n\n* [derJD](https://github.com/derJD/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderjd%2Fpython-mkblog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fderjd%2Fpython-mkblog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fderjd%2Fpython-mkblog/lists"}