QuickieDox has a very lean directory structure. This is possible because it is void of any framework. Below is a list of the directories and files that make up QuickieDox.
| Directory | Files | Description |
|---|---|---|
Root Directory |
index.php | Entry point of the app. Loads and sets environment variables as well as routes |
| config.php | Configurable variables that get loaded and used throughout the app | |
| .env-example | Example file containing environment variables | |
| deploy-example.php | Example deployment script to help deploy documentation to production or test server. Requires deployer/deployer package. | |
| composer.json | List of packages to pull in to app | |
| routes.php | Defines routes used in loading different pages in the app | |
| tailwind.config.js | TailwindCSS configuration file | |
assets > css |
prism.css | css file for handling code highlighting |
| quickiedox.css | main css file for the app | |
assets > images |
contains image files used in the app | |
assets > js |
prism.js | javascript file for code highlighting |
| quickiedox.js | main js file for the app | |
Controllers |
DocController.php | handles interaction between the user interface and the backend |
| AuthController.php | placeholder file for writing out your authentication logic | |
Core |
App.php | sets and gets variables that are available throughout the app |
| Auth.php | placeholder file for writing out your authentication logic | |
| bootstrap.php | loads in all configuration variables and sets them globally using App.php | |
| Doc.php | handles manipulation of md files for reading | |
| Envy.php | handles reading of variables from .env file | |
| helpers.php | helper functions for performing repeated functions | |
| Request.php | handles url requests | |
| Router.php | handles routing mechanism | |
| Session.php | sets and unsets session variables. Sessions here are mostly url parameters | |
src |
index.css | source css file before it is compiled to assets/css/quickiedox.css |
vendor |
composer packages are pulled in here | |
views |
404.md | default 404 markdown file. Used when pages are missing. This is placed in the views directory instead of markdown because the file always needs to be available even if the user decides to load their md files from a directory other than markdown |
| 404.php | page displayed when a route is missing. This is different from what is displayed when a documentation page is missing | |
| auth-required.md | displayed if docs require reader to be signed in but they are not | |
| header.php | shared include file used by home.php, pin.php and reader.php | |
| home.php | default homepage | |
| pin.php | PIN verification page showed before pulling in .md documentation files | |
| reader.php | layout page for displaying documentation for reading |
In This Document
