PHPackages mkocansey/quickiedox - 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. [Templating & Views](/categories/templating) 4. / 5. mkocansey/quickiedox ActiveProject[Templating & Views](/categories/templating) mkocansey/quickiedox ==================== Quickly create elegant documentation from markdown files. v1.0.7(1y ago)5261[2 issues](https://github.com/mkocansey/quickiedox/issues)MITPHPPHP >=7.4 Since Mar 22Pushed 1y agoCompare [ Source](https://github.com/mkocansey/quickiedox)[ Packagist](https://packagist.org/packages/mkocansey/quickiedox)[ Docs](https://quickiedox.com)[ RSS](/packages/mkocansey-quickiedox/feed)WikiDiscussions main Synced today READMEChangelog (8)Dependencies (3)Versions (9)Used By (0) Overview ======== [](#overview) QuickieDox is a **purely vanilla PHP**( >= 7.4) project that allows you to quickly create elegant documentation from markdown files. Visit for the full documentation. QuickieDox is not software as a service, thus, doesn't host any documentation. You will need to host everything yourself just like you would host any of your websites. Who Can Use QuickieDox ---------------------- [](#who-can-use-quickiedox) - To use QuickieDox you must already know how to write markdown syntax and also know some basic PHP. [This guide](https://www.markdownguide.org/getting-started/) can bring you up to speed on writing markdown. - Anyone with documentation needs regardless of the size can use QuickieDox Installation ------------ [](#installation) There are two ways to create your own documentation website using QuickieDox. ### Via Composer [](#via-composer) This option is the easiest. Simply run the command below. ``` # replace your-project-name with the name of the directory you want created # or the name of your project (directory will be created if it does not exist) ``` ``` composer create-project mkocansey/quickiedox your-project-name ``` ### Clone From GitHub: HTTPS [](#clone-from-github-https) ``` # create a directory where you want to clone quickiedox # cd into that directory and run ``` ``` git clone https://github.com/mkocansey/quickiedox.git ``` ### Clone From GitHub: SSH [](#clone-from-github-ssh) ``` # create a directory where you want to clone quickiedox # cd into that directory and run ``` ``` git clone git@github.com:mkocansey/quickiedox.git ``` Rename .env-example ------------------- [](#rename-env-example) You will find a `.env-example` file at the root of the project you just cloned. Rename it to `.env`. The app will not run if this is not done. ``` mv .env-example .env ``` Run the App ----------- [](#run-the-app) Now that you have cloned the repo, let us run the app to ensure you can see the documentation that ships by default. From the root of the directory you just created, run: ``` composer install ``` Let's start an inbuilt PHP server to quickly test. Still at the root of the project, type ``` php -S localhost:8000 ``` The above ccommand assumes port 8000 is not in use by another site or app. You should see output similar to what is below. The version of PHP might differ depending on what you have installed on your machine. ``` [Thu Mar 9 00:11:36 2023] PHP 8.2.3 Development Server (http://localhost:8000) started ``` Navigating to should display the screen below. [![QuickieDox Homepage](https://camo.githubusercontent.com/09e1783b9e92bdf191678c6a65b486e43fad6b42212cb1bcafc4b5dbc5d82b32/68747470733a2f2f717569636b6965646f782e636f6d2f6173736574732f696d616765732f686f6d65706167652e6a7067)](https://camo.githubusercontent.com/09e1783b9e92bdf191678c6a65b486e43fad6b42212cb1bcafc4b5dbc5d82b32/68747470733a2f2f717569636b6965646f782e636f6d2f6173736574732f696d616765732f686f6d65706167652e6a7067) Clicking on **Read Documentation** from the home page as shown in the image above should display the screen below. [![QuickieDox Homepage](https://camo.githubusercontent.com/2377866cedd2fbe1eca05ed2a64afd2dca388c5a41554f56dfbddebe78cf34f1/68747470733a2f2f717569636b6965646f782e636f6d2f6173736574732f696d616765732f696e7374616c6c6174696f6e2e6a7067)](https://camo.githubusercontent.com/2377866cedd2fbe1eca05ed2a64afd2dca388c5a41554f56dfbddebe78cf34f1/68747470733a2f2f717569636b6965646f782e636f6d2f6173736574732f696d616765732f696e7374616c6c6174696f6e2e6a7067) You can tell from the above image that QuickieDox is unable to load the documentation navigation or the default documentation pages. This is very much expected since **we have not pulled in the markdown files** that make up the documentation. By default QuickieDox expects the markdown files to be in the `markdown` directory at the root of the project you just created. You can use any directory name of your choice but just make sure you update the [config file](https://quickiedox.com/docs/main/customize-config) to tell QuickieDox where to load your `.md` files from. Pull In The Markdown Files -------------------------- [](#pull-in-the-markdown-files) The markdown files that make up the documentation are expected to sit in a directory you specify. The default is `markdown`. The [assumption/convention](https://quickiedox.com/docs/main/convention-doc) here is that your markdown files are hosted in their own git repo. There are two ways to pull in the markdown files. ### Use The Inbuilt Cloning Tool [](#use-the-inbuilt-cloning-tool) #### via HTTP [](#via-http) It is much easier to pull in your markdown files using the cloning URL that is built into QuickieDox. Assuming you are still running the app from the server we started above using `php -S localhost:8000`, you will need to visit the URL below. Ensure you have properly modified your QuickieDox [configurations](https://quickiedox.com/docs/main/customize-config). The URL will ask for the PIN you defined in the `.env` or `.config.php` file as `GIT_CLONE_PIN`. You won't be able to use this URL if your PIN is blank. #### via The clone.sh File [](#via-the-clonesh-file) Cloning via HTTP will work well if you are cloning from public repositories. If you are cloning your documentation from a private repository, using the `clone.sh` file is a better option. Included at the root of the project is a `clone.sh` shell script that pulls in your markdown files from the repo you specify. You will need to edit the file to change the default values defined for `GIT_REPO_URL`, `DOCS_DIRECTORY` and `DOC_VERSIONS `. ``` # clone.sh #!/bin/bash # update this to your own documentation repo url GIT_REPO_URL="https://github.com/mkocansey/quickiedox-mds.git" # update this to the directory you prefer to clone your docs into DOCS_DIRECTORY="markdown" # note the versions are not strings # each version needs to be defined on its own line without quotes DOC_VERSIONS=( main #master #2.x #1.x ) ``` Ensure the script has permissions to execute for owner and/or group. Run. ``` ls -l clone.sh # you should get an output similar to the line below -rwxr-xr--@ 1 your-username your-group 1026 Mar 20 11:14 clone.sh ``` Now run this command to execute the shell script to pull in the documentation. ``` ./clone.sh ``` ### Copy and Paste [](#copy-and-paste) QuickieDox only needs `.md` files in the `markdown` directory. You can simple copy and paste your `.md` files into this directory and voila! If your documentation is in versions, you will need to have a separate directory for every version. For example, if your documentation has versions 1.5 and 2.2, you will need to create `1.5` and `2.2` directories in the `markdown` directory. You will then need to copy the appropriate `.md` files into their respective directories. See the [Conventions > Versioning docs](https://quickiedox.com/docs/main/convention-versions) for more on this. Further Reading --------------- [](#further-reading) Visit for the full documentation but these should help you better understand how QuickieDox works. - [Directory Structure](https://quickiedox.com/docs/main/structure) - [The Configuration File](https://quickiedox.com/docs/main/customize-config) - [The Navigation File](https://quickiedox.com/docs/main/customize-nav) - [Versioning Your ocumentation](https://quickiedox.com/docs/main/convention-versions) - [Customizing The Homepage](https://quickiedox.com/docs/main/customize-home) - [How QuickieDox Works](https://quickiedox.com/docs/main/architecture) - [Deploying Your Docs](https://quickiedox.com/docs/main/structure) Known Issues ------------ [](#known-issues) - Integration of Algolia - Faster site-wide search - Protecting docs that require signiing in before reading - Top level navigation items can only be parents and not links to pages Support ------- [](#support) You can tweet [@quickiedox](https://twitter.com/quickiedox) or email if you have any questions. ### Health Score 30 — LowBetter than 62% of packages Maintenance40 Moderate activity, may be stable Popularity12 Limited adoption so far Community7 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure 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. ### Release Activity Cadence Every ~114 days Recently: every ~200 days Total 8 Last Release 394d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/1946332?v=4)[Michael K. Ocansey](/maintainers/mkocansey)[@mkocansey](https://github.com/mkocansey) --- Top Contributors [![mkocansey](https://avatars.githubusercontent.com/u/1946332?v=4)](https://github.com/mkocansey "mkocansey (55 commits)") --- Tags documentationmarkdowntemplate ### Embed Badge ![Health badge](/badges/mkocansey-quickiedox/health.svg) ``` [![Health](https://phpackages.com/badges/mkocansey-quickiedox/health.svg)](https://phpackages.com/packages/mkocansey-quickiedox) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.8k543.8M20.0k](/packages/laravel-framework)[tempest/framework The PHP framework that gets out of your way. 2.2k34.4k15](/packages/tempest-framework)[statamic/cms The Statamic CMS Core Package 4.8k3.6M981](/packages/statamic-cms)[craftcms/cms Craft CMS 3.6k3.6M3.1k](/packages/craftcms-cms)[helsingborg-stad/municipio A bootstrap theme for creating municipality sites. 4028.5k10](/packages/helsingborg-stad-municipio) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)