{"id":15188421,"url":"https://github.com/tillerburr/pymdownx-blocks","last_synced_at":"2026-03-03T17:32:58.368Z","repository":{"id":203608441,"uuid":"710008631","full_name":"TillerBurr/pymdownx-blocks","owner":"TillerBurr","description":"Custom Blocks for PyMdown Extensions ","archived":false,"fork":false,"pushed_at":"2023-12-12T21:21:26.000Z","size":42,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-27T03:15:10.725Z","etag":null,"topics":["markdown","mkdocs","mkdocs-material","pymdown-extensions","python"],"latest_commit_sha":null,"homepage":"","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/TillerBurr.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}},"created_at":"2023-10-25T20:25:28.000Z","updated_at":"2024-02-01T19:50:00.000Z","dependencies_parsed_at":"2023-12-12T20:33:57.104Z","dependency_job_id":"e170f731-5a85-4d9a-882d-86905583e16d","html_url":"https://github.com/TillerBurr/pymdownx-blocks","commit_stats":null,"previous_names":["tillerburr/pymdownx-blocks"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TillerBurr%2Fpymdownx-blocks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TillerBurr%2Fpymdownx-blocks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TillerBurr%2Fpymdownx-blocks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TillerBurr%2Fpymdownx-blocks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TillerBurr","download_url":"https://codeload.github.com/TillerBurr/pymdownx-blocks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240970218,"owners_count":19886526,"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":["markdown","mkdocs","mkdocs-material","pymdown-extensions","python"],"created_at":"2024-09-27T19:05:12.018Z","updated_at":"2026-03-03T17:32:58.312Z","avatar_url":"https://github.com/TillerBurr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PyMdown Extensions Blocks\n\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![PyPI - Version](https://img.shields.io/pypi/v/pymdownx-blocks)](https://pypi.org/project/pymdownx-blocks/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pymdownx-blocks)\n[![Tests](https://github.com/TillerBurr/pymdownx-blocks/workflows/Tests/badge.svg)](https://github.com/TillerBurr/pymdownx-blocks/actions)\n\n\n\nThese are a collection of blocks for the [PyMdown Extensions](https://facelessuser.github.io/pymdown-extensions) that I find useful.\n\nThis project is not affiliated with the PyMdown Extensions project and is currently in a very early stage. Currently, there is only one block: `DirTree`.\n\n## Installation\n\n```bash\npip install pymdownx-blocks\n```\n\n## Usage\nThis can be used in MkDocs or by itself. To use in a Python file, we use the following:\n\n```python\nimport markdown\n\nyaml_str=...\nmd=markdown.Markdown(extensions=['pymdownx_blocks.dirtree'])\n```\n\nTo use in MkDocs, register the extension.\n\n```yaml\n...\nmarkdown_extensions:\n...\n- pymdownx_blocks.dirtree\n...\n```\n\nIn a markdown file, \n```\n///dirtree\n\nroot:\n- subdir:\n  - File\n- another subdir:\n  - anotherfile.txt\n  - file.csv\n///\n```\n\n\nWhen rendered, this will produce the following tree\n\n\u003cdiv\u003e\n\u003cpre class=\"admonition note\"\u003e\u003cp class=\"admonition-title\"\u003eDirectory Structure\u003c/p\u003e\n\u003cp\u003e \nroot\n├── subdir \n│   └── File\n└── another subdir\n    ├── anotherfile.txt \n    └── file.csv\n\u003c/p\u003e\u003c/pre\u003e\n\u003c/div\u003e\n\n\n## Contributing \n\nMore blocks are always welcome! This project uses [rye](https:rye-up.com) for dependency\nmanagement.\n\n1. Fork the repository\n2. Create a branch with the name of the block\n3. Implement the block\n4. Create a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftillerburr%2Fpymdownx-blocks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftillerburr%2Fpymdownx-blocks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftillerburr%2Fpymdownx-blocks/lists"}