{"id":28899533,"url":"https://github.com/jeffersonrucu/wp_docsify","last_synced_at":"2025-07-20T08:04:55.005Z","repository":{"id":298954088,"uuid":"1001597386","full_name":"jeffersonrucu/WP_Docsify","owner":"jeffersonrucu","description":"Docsify for WordPress in a simple and practical way using the entire WordPress structure.","archived":false,"fork":false,"pushed_at":"2025-06-15T23:26:15.000Z","size":44,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-07-14T13:09:09.738Z","etag":null,"topics":["docsify","wordpress","wordpress-plugin"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jeffersonrucu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2025-06-13T16:52:47.000Z","updated_at":"2025-06-23T13:13:52.000Z","dependencies_parsed_at":"2025-06-13T20:38:00.470Z","dependency_job_id":null,"html_url":"https://github.com/jeffersonrucu/WP_Docsify","commit_stats":null,"previous_names":["jeffersonrucu/wp_docsify"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jeffersonrucu/WP_Docsify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersonrucu%2FWP_Docsify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersonrucu%2FWP_Docsify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersonrucu%2FWP_Docsify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersonrucu%2FWP_Docsify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jeffersonrucu","download_url":"https://codeload.github.com/jeffersonrucu/WP_Docsify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jeffersonrucu%2FWP_Docsify/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266087790,"owners_count":23874519,"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":["docsify","wordpress","wordpress-plugin"],"created_at":"2025-06-21T08:40:39.303Z","updated_at":"2025-07-20T08:04:54.985Z","avatar_url":"https://github.com/jeffersonrucu.png","language":"PHP","readme":"\u003cp align=\"center\"\u003e\r\n  \u003ca href=\"https://docsify.js.org\"\u003e\r\n    \u003cimg alt=\"docsify\" src=\"https://docsify.js.org/_media/icon.svg\"\u003e\r\n  \u003c/a\u003e\r\n\u003c/p\u003e\r\n\r\n\u003cp align=\"center\"\u003e\r\n  A magical documentation site generator inside wordpress.\r\n\u003c/p\u003e\r\n\r\n**WP Docsify** is a WordPress plugin that allows you to create and manage documentation using [Docsify](https://docsify.js.org/), leveraging `.md` files directly within your project. It's ideal for technical projects, user manuals, or any kind of versioned technical documentation.\r\n\r\n![image](https://github.com/user-attachments/assets/00a41df7-1b7b-4987-80b7-6fbea95e2070)\r\n\r\n![image](https://github.com/user-attachments/assets/ef471225-3e9b-4690-81e1-2c201924685a)\r\n\r\n## 📁 Project Structure\r\n\r\n```\r\nwp-docsify/\r\n├── src/\r\n│   ├── docs/                    # Where Markdown (.md) files should be created\r\n│   └── template-wp-docsify.php  # Template file responsible for rendering Docsify\r\n```\r\n\r\n## 🧩 Features\r\n\r\n- Direct integration of Docsify into WordPress\r\n- Reads `.md` files from the `src/docs/` directory\r\n- Automatic rendering via a custom template\r\n- Simple and database-independent\r\n\r\n## 🛠️ Installation\r\n\r\n1. Clone this repository or place the plugin in your WordPress plugins directory:\r\n\r\n```bash\r\nwp-content/plugins/wp-docsify/\r\n```\r\n\r\n2. Activate the plugin through the WordPress admin panel.\r\n\r\n3. Create a page in WordPress and select the **\"WP Docsify\"** template (template-wp-docsify.php).\r\n\r\n## ✍️ How to Use\r\n\r\n1. Add your documentation `.md` files inside the directory:\r\n\r\n```\r\nwp-content/plugins/wp-docsify/src/docs/{locale}/\r\n```\r\n\r\n2. The `README.md` file will be used as the documentation's home page.\r\n\r\n3. Customize Docsify behavior (menus, themes, etc.) directly in the `template-wp-docsify.php` file.\r\n\r\n## ✅ Example\r\n\r\n```markdown\r\n# Welcome to WP Docsify\r\n\r\nThis is the initial documentation.\r\n\r\n## Installation\r\n\r\nFollow the steps to install and configure the plugin.\r\n```\r\n\r\n---\r\n\r\nDeveloped by Jefferson Oliveira using the https://docsify.js.org library 🧑‍💻\r\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffersonrucu%2Fwp_docsify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjeffersonrucu%2Fwp_docsify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjeffersonrucu%2Fwp_docsify/lists"}