{"id":14065463,"url":"https://github.com/timvink/mkdocs-table-reader-plugin","last_synced_at":"2025-04-09T05:10:27.640Z","repository":{"id":39492870,"uuid":"245381816","full_name":"timvink/mkdocs-table-reader-plugin","owner":"timvink","description":"MkDocs plugin that enables a markdown tag like {{ read_csv('table.csv') }} to directly insert various table formats into a page","archived":false,"fork":false,"pushed_at":"2025-03-28T11:20:06.000Z","size":2400,"stargazers_count":141,"open_issues_count":4,"forks_count":22,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T04:03:35.265Z","etag":null,"topics":["mkdocs","mkdocs-plugin","pandas","tables","tabulate"],"latest_commit_sha":null,"homepage":"https://timvink.github.io/mkdocs-table-reader-plugin/","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/timvink.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":null},"created_at":"2020-03-06T09:42:26.000Z","updated_at":"2025-04-01T20:58:18.000Z","dependencies_parsed_at":"2024-03-08T20:15:31.071Z","dependency_job_id":"0d8c1399-17c7-49f7-a310-c23c30d67310","html_url":"https://github.com/timvink/mkdocs-table-reader-plugin","commit_stats":{"total_commits":141,"total_committers":9,"mean_commits":"15.666666666666666","dds":"0.21276595744680848","last_synced_commit":"28bd5c277ef87f6227045dd1c041b845c3da9780"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-table-reader-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-table-reader-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-table-reader-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timvink%2Fmkdocs-table-reader-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timvink","download_url":"https://codeload.github.com/timvink/mkdocs-table-reader-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247980837,"owners_count":21027808,"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":["mkdocs","mkdocs-plugin","pandas","tables","tabulate"],"created_at":"2024-08-13T07:04:30.340Z","updated_at":"2025-04-09T05:10:27.615Z","avatar_url":"https://github.com/timvink.png","language":"Python","readme":"[![Actions Status](https://github.com/timvink/mkdocs-table-reader-plugin/workflows/pytest/badge.svg)](https://github.com/timvink/mkdocs-table-reader-plugin/actions)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocs-table-reader-plugin)\n![PyPI](https://img.shields.io/pypi/v/mkdocs-table-reader-plugin)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/mkdocs-table-reader-plugin)\n[![codecov](https://codecov.io/gh/timvink/mkdocs-table-reader-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/timvink/mkdocs-table-reader-plugin)\n![GitHub contributors](https://img.shields.io/github/contributors/timvink/mkdocs-table-reader-plugin)\n![PyPI - License](https://img.shields.io/pypi/l/mkdocs-table-reader-plugin)\n\n# mkdocs-table-reader-plugin\n\n[MkDocs](https://www.mkdocs.org/) plugin that enables a markdown tag like `{{ read_csv('table.csv') }}` to directly insert various table formats into a page. \n\n\u003e For a workflow with other plugins see the blogpost [building reproducible reports with MkDocs](https://timvink.nl/reproducible-reports-with-mkdocs/)\n\n## Installation\n\nInstall the plugin using `pip`:\n\n```bash\npip install mkdocs-table-reader-plugin\n```\n\nNext, add the following lines to your `mkdocs.yml`:\n\n```yml\nplugins:\n  - search\n  - table-reader\n```\n\n\u003e If you have no `plugins` entry in your config file yet, you'll likely also want to add the `search` plugin. MkDocs enables it by default if there is no `plugins` entry set.\n\n## Usage\n\nIn your markdown files you can now use:\n\n```html\n{{ read_csv('path_to_table.csv') }}\n```\n\nWhere the path is relative to the location of your project's `mkdocs.yml` file, _or_ your project's `docs/` directory, _or_ the location of your markdown source file (all 3 possible locations will be searched, in that order).\n\n- There are [readers](https://timvink.github.io/mkdocs-table-reader-plugin/readers/) available for many common table formats, like `.csv`, `.fwf`, `.json`, `.xls`, `.xlsx`, `.yaml`, `.feather` and `.tsv`. There is also the `read_raw()` reader that will allow you to insert tables (or other content) already in markdown format.\n- `table-reader` is compatible with [`mkdocs-macros-plugin`](https://mkdocs-macros-plugin.readthedocs.io/en/latest/). This enables further automation like filtering tables or inserting directories of tables. See the documentation on [compatibility with macros plugin](howto/use_jinja2.md) for more examples.\n\n## Documentation and how-to guides\n\nSee [timvink.github.io/mkdocs-table-reader-plugin/](https://timvink.github.io/mkdocs-table-reader-plugin/)\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-table-reader-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimvink%2Fmkdocs-table-reader-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimvink%2Fmkdocs-table-reader-plugin/lists"}