The variables defined in .env{.inline} and config.php{.inline} allow you to easily customize QuickieDox to suit your needs. The config.php{.inline} sets defaults for variables it is expecting to be defined in the .env{.inline} file. Below is a list of all the variables in both files and what they are used for.
| .env | config.php | Description |
|---|---|---|
environment{.inline} {nowrap="nowrap" valign="top"} |
environment{.inline} {valign="top"} |
Default: development The environment the project is running in. This variable is unused in QuickieDox itself at the moment but we dropped the variable in there in case you want to perform environment-specific tasks. |
default_page_title{.inline} {valign="top"} |
Default: API Documentation The default text displayed in the title bar. Specific documentation page titles are appended to this. |
|
ALLOW_TESTING{.inline} {nowrap="nowrap" valign="top"} |
allow_testing{.inline} {valign="top"} |
Default: false Applies to API related docs. Should users be able to test your endpoints. If true, a button is displayed bottom right of the docs page to launch an endpoint tester. |
TESTING_URL{.inline} {nowrap="nowrap" valign="top"} |
testing_url{.inline} {valign="top"} |
Default: blank If allow_testing{.inline} is true, what URL will be the default for such endpoint tests. |
SHOW_INDEX_PAGE{.inline} {nowrap="nowrap" valign="top"} |
show_index_page{.inline} {valign="top"} |
Default: true Defines if home page should be displayed. If false, the user is taken right to your default documentation page ( default_doc_page{.inline}). |
REQUIRE_SIGNIN{.inline} {nowrap="nowrap" valign="top"} |
require_signin{.inline} {valign="top"} |
Default: false Defines if doc pages can only be accessed by logged in users. More on that here. |
whitelisted_docs{.inline} {valign="top"} |
Default: [] If require_signin{.inline} is true but you want some specific pages to always be. accessible. Example: [ 'installation', 'upgrade-guide' ]. You can either include or exclude the (.md) file extension. |
|
DOCS_DIRECTORY{.inline} {nowrap="nowrap" valign="top"} |
docs_directory{.inline} {valign="top"} |
Default: markdown Directory to load and read .md files from. |
doc_versions{.inline} {valign="top"} |
Default: [] Verious documentation versions to track. Only values defined here will be accessible in the dropdown of versions on the docs page. See more. |
|
DEFAULT_DOC_PAGE{.inline} {nowrap="nowrap" valign="top"} |
default_doc_page{.inline} {valign="top"} |
Default: overview.md The default documentation .md file. This is always the page displayed when a user clicks on the logo to go back 'home' |
NAV_PAGE{.inline} {nowrap="nowrap" valign="top"} |
nav_page{.inline} {valign="top"} |
Default: navigation.md The file where all your navigation items are defined. |
DOCS_URL_PREFIX{.inline} {nowrap="nowrap" valign="top"} |
docs_url_prefix{.inline} {valign="top"} |
Default: docs This prefixes urls to the documentation in the browser. http://ur-docs-url.com/docs_url_prefix. Default is docs. If you change it to say documentation your URL will look like http://my-docs-url.com/documentation |
message_if_no_navigation{.inline} {valign="top"} |
Default: no navigation.md file found Message to display if no navigation.md file is found |
|
DISPLAY_LINE_NUMBERS{.inline} {nowrap="nowrap" valign="top"} |
display_line_numbers{.inline} {valign="top"} |
Default: false Determines if line numbers should be displayed for all code blocks. Line numbers can be defined on a case by case basis. |
GIT_CLONE_PIN{.inline} {nowrap="nowrap" valign="top"} |
git_clone_pin{.inline} {valign="top"} |
Default: blank PIN required when pulling in the markdown (.md) files in the browser as explained in the installation guide here |
MD_REPO_URL{.inline} {nowrap="nowrap" valign="top"} |
md_repo_url{.inline} {valign="top"} |
Default: https://github.com/mkocansey/quickiedox-mds.git Git repo url where markdown (.md) files will be pulled in from |
ALLOW_EDIT_ON_GIT{.inline} {nowrap="nowrap" valign="top"} |
allow_edit_on_git{.inline} {valign="top"} |
Default: false When true, an 'edit on Github' link is placed at the end of each document |