PHPackages easyengine/handbook-command - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. easyengine/handbook-command AbandonedArchivedEe-handbook-package[Utility & Helpers](/categories/utility) easyengine/handbook-command =========================== Generate markdown's for ee commands 7118[14 issues](https://github.com/EasyEngine/docs/issues)PHP Since Sep 12Pushed 7y ago5 watchersCompare [ Source](https://github.com/EasyEngine/docs)[ Packagist](https://packagist.org/packages/easyengine/handbook-command)[ RSS](/packages/easyengine-handbook-command/feed)WikiDiscussions master Synced 6d ago READMEChangelogDependenciesVersions (2)Used By (0) easyengine/docs =============== [](#easyenginedocs) ⚠️ ***WIP:** This repo is currently work in progress!* 🚧 The purpose of this repo is to hold EasyEngine v4 documentation as of now. Over the time, we hope to make all tutorials published on EasyEngine.io available here. V4 Docs ------- [](#v4-docs) EasyEngine v4 documentation is divided into two parts. ### Commands reference [](#commands-reference) This part is automatically generated by parsing PHP docblock. Please do not edit markdown files in `commands` folder as they may get overwritten any time. If you want to send a fix for a command documentation, the best way to do is send a pull request with changes to PHP docblock on its respective repo. Alternatively, is to create a new issue in this repo with details such as: 1. EE Command for which you are sending a fix 2. Mention the wrong part (screenshot is also fine) 3. Mention the correct part (optional) ### Handbook [](#handbook) EasyEngine v4 has a lot to it. The docker magic, new filesystem layouts a lot more. This is a part which is independent of any command. For now, we are [creating issues labeled `documentation`](https://github.com/EasyEngine/docs/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) for each such aspect which we feel needs documentation. You can help in the following ways: #### Write a new documentation [](#write-a-new-documentation) If you are familiar with EasyEngine v4 1. Pick an [issue labeled `documentation`](https://github.com/EasyEngine/docs/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation). 2. Please post a comment on the issue saying something like "working on this". So others will not pick the same issue. 3. [Fork this repo](https://github.com/EasyEngine/docs/fork)! 4. Create a new markdown file for the issue in folder `handbook/`. Please avoid spaces in filename. Use `-` as a separator. Keep all characters lowercase. 5. Once you are done writing markdown file, submit it via pull request (PR). If for some reason, you can't send PR, you can write down documentation as comment on relevant issue. Please use markdown. We will copy your comment manually! #### Update existing documentation [](#update-existing-documentation) You can help with documentation update in two ways: 1. English is not a primary language of any core team member. So if you can improve *langauge* of the documentation so it becomes easy to understand, that would be a great help. 2. Send updates to improve accuracy, add more information or even fix typos! Documentation Hosting --------------------- [](#documentation-hosting) We are not using Github pages or any static site generator. Instead another team at rtCamp is working on a solution which will seamlessly publish these markdown files in a WordPress site as pages. Their WordPress custom code will take care of all the bells & whistles a documentation sites need such as: - stylining (theming), - table of content - listing subpages - breadcrumb - search - related pages - meta data such as title, discription, slug We will be open sourcing WordPress custom code also so that any other project which wish to make use of such documentation flow will benefit from this. We are using some codes from wp-cli. wp-cli project documenation is also built like this. Once we have documentation site ready, we will add its URL here. The good part is - we are writing in markdown files which if nothing else works *(by Nov 15, 2018)*, can be quickly converted into Github Pages! 😉 ### The proposed build process [](#the-proposed-build-process) 1. All EasyEngine comamnds repos and this docs repo will have CI/CD setup. 2. Whenever something changes, a build process will run which will invoke a wp-cli command (WordPress custom code). 3. That wp-cli command will take care of updating WordPress sites in appropriate way. Legacy flow ----------- [](#legacy-flow) The documentation is located in GitHub to enable a pull request-based editing workflow. Long-form documentation can be edited directly. Command pages are generated dynamically from the EasyEngine codebase using the `ee handbook gen_commands` series of commands. `ee handbook gen-all` will regenerate all of the command pages and handbook pages. All documentation is imported automatically into docs.easyengine.io in a two step process: 1. WordPress reads `commands-manifest.json` and `handbook-manifest.json` to understand all pages that need to be created. 2. Each WordPress page has a `markdown_source` attribute specifying a Markdown file to be fetched, converted to HTML, and saved in the database. For docs.easyengine.io, the import process is running a WP Cron job on every push to github repo. ### Health Score 20 — LowBetter than 14% of packages Maintenance0 Infrequent updates — may be unmaintained Popularity14 Limited adoption so far Community20 Small or concentrated contributor base Maturity42 Maturing project, gaining track record Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/85d12e799d478a9ff2c22546fc96d056712b76e6895a6519dde4cb71fe80cb78?d=identicon)[easyengine](/maintainers/easyengine) --- Top Contributors [![kirtangajjar](https://avatars.githubusercontent.com/u/8456197?v=4)](https://github.com/kirtangajjar "kirtangajjar (70 commits)")[![rahul286](https://avatars.githubusercontent.com/u/4115?v=4)](https://github.com/rahul286 "rahul286 (64 commits)")[![sagarnasit](https://avatars.githubusercontent.com/u/25276905?v=4)](https://github.com/sagarnasit "sagarnasit (26 commits)")[![rahulsprajapati](https://avatars.githubusercontent.com/u/10358350?v=4)](https://github.com/rahulsprajapati "rahulsprajapati (5 commits)")[![mbtamuli](https://avatars.githubusercontent.com/u/10382077?v=4)](https://github.com/mbtamuli "mbtamuli (4 commits)")[![mrrobot47](https://avatars.githubusercontent.com/u/25586785?v=4)](https://github.com/mrrobot47 "mrrobot47 (3 commits)")[![traviscibot](https://avatars.githubusercontent.com/u/33116358?v=4)](https://github.com/traviscibot "traviscibot (2 commits)")[![nitun](https://avatars.githubusercontent.com/u/1140051?v=4)](https://github.com/nitun "nitun (1 commits)") --- Tags documentationeasyengine ### Embed Badge ![Health badge](/badges/easyengine-handbook-command/health.svg) ``` [![Health](https://phpackages.com/badges/easyengine-handbook-command/health.svg)](https://phpackages.com/packages/easyengine-handbook-command) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)