{"id":16756585,"url":"https://github.com/gnowland/markdown-wordpress-docs","last_synced_at":"2026-04-13T07:05:03.340Z","repository":{"id":56478799,"uuid":"310165493","full_name":"gnowland/markdown-wordpress-docs","owner":"gnowland","description":"A lightweight WordPress Plugin to generate documentation pages for your WordPress site from Markdown files ","archived":false,"fork":false,"pushed_at":"2020-11-05T06:18:36.000Z","size":31,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-09T22:14:34.658Z","etag":null,"topics":["markdown","wordpress","wordpress-plugin"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gnowland.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}},"created_at":"2020-11-05T02:05:25.000Z","updated_at":"2022-04-03T00:22:24.000Z","dependencies_parsed_at":"2022-08-15T19:31:12.978Z","dependency_job_id":null,"html_url":"https://github.com/gnowland/markdown-wordpress-docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gnowland%2Fmarkdown-wordpress-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gnowland%2Fmarkdown-wordpress-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gnowland%2Fmarkdown-wordpress-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gnowland%2Fmarkdown-wordpress-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gnowland","download_url":"https://codeload.github.com/gnowland/markdown-wordpress-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243836982,"owners_count":20355808,"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","wordpress","wordpress-plugin"],"created_at":"2024-10-13T03:26:20.868Z","updated_at":"2026-04-13T07:05:03.311Z","avatar_url":"https://github.com/gnowland.png","language":"CSS","funding_links":["https://www.buymeacoffee.com/gnowland"],"categories":[],"sub_categories":[],"readme":"# Markdown WordPress Docs\n[![GitHub release](https://img.shields.io/github/release/gnowland/markdown-wordpress-docs.svg?style=flat-square)](https://github.com/gnowland/markdown-wordpress-docs/releases)\n|\n[![Packagist](https://img.shields.io/packagist/v/gnowland/markdown-wordpress-docs.svg?style=flat-square)](https://packagist.org/packages/gnowland/markdown-wordpress-docs)\n|\n[![buymeacoffee.com/gnowland](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-donate-yellow.svg?style=flat-square)](https://www.buymeacoffee.com/gnowland)\n\n\nA lightweight WordPress Plugin that generates admin documentation/help pages for your WordPress site from Markdown files.\n\n## Use\n\n1. Add Markdown files to `docs/`\n2. [Install](#install) \u0026 Activate plugin in WordPress Admin\n\n### Details\n\n- `/docs` should contain all your Markdown files\n- Links to `../[DOCUMENT_NAME.md]`, `./[DOCUMENT_NAME.md]` or `docs/[DOCUMENT_NAME.md]` will automatically route to display the file using URL Parameters `?page=docs\u0026doc=[DOCUMENT_NAME].md`\n  - I recommend dividing files into subjects and including a Table of Contents in `docs/README.md`.\n- The help page will be displayed in the Dashboard sub-menu\n\n## Installation ##\n\n### Composer ###\n\n```shell\ncomposer require gnowland/markdown-wordpress-documentation\n```\n\nActivate with [wp-cli](http://wp-cli.org/)\n\n```shell\nwp plugin activate markdown-wordpress-documentation\n```\nor in the WordPress Admin panel.\n\n### Git ###\n\n* `git clone` into your sites plugin folder\n* Activate via WordPress or wp-cli (see above) or in WordPress Admin\n\n### Manually ###\n\n* Download the [latest release](https://github.com/gnowland/markdown-wordpress-docs/releases) as a `.zip` file\n* Unzip to your sites plugin folder\n* Activate via WordPress Admin or wp-cli (see above)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgnowland%2Fmarkdown-wordpress-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgnowland%2Fmarkdown-wordpress-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgnowland%2Fmarkdown-wordpress-docs/lists"}