PHPackages                             phpfui/instadoc - 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. [PDF & Document Generation](/categories/documents)
4. /
5. phpfui/instadoc

ActiveLibrary[PDF & Document Generation](/categories/documents)

phpfui/instadoc
===============

Instant and always up to date documentation for PHP projects

V3.1.11(1w ago)61.0k1MITPHPPHP >=8.0 <8.6CI failing

Since Jan 4Pushed 1w ago1 watchersCompare

[ Source](https://github.com/phpfui/InstaDoc)[ Packagist](https://packagist.org/packages/phpfui/instadoc)[ Docs](https://github.com/phpfui/InstaDoc)[ RSS](/packages/phpfui-instadoc/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (10)Dependencies (39)Versions (77)Used By (0)

PHPFUI\\InstaDoc Library [![Tests](https://github.com/phpfui/InstaDoc/actions/workflows/tests.yml/badge.svg)](https://github.com/phpfui/InstaDoc/actions?query=workflow%3Atests) [![Latest Packagist release](https://camo.githubusercontent.com/66c82124df611e0edf7aaae992dc63193d082d147da722f3cf9cf45319c71792/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7068706675692f496e737461446f632e737667)](https://packagist.org/packages/phpfui/InstaDoc) [![](https://camo.githubusercontent.com/742e8be8005b1fe76a64a5d8f5e6a5d4f63bf315e9a44a6d23e4e11c76b0555f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d6c6576656c253230362d627269676874677265656e2e7376673f7374796c653d666c6174)](https://camo.githubusercontent.com/742e8be8005b1fe76a64a5d8f5e6a5d4f63bf315e9a44a6d23e4e11c76b0555f/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d6c6576656c253230362d627269676874677265656e2e7376673f7374796c653d666c6174)
======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#phpfuiinstadoc-library---)

A quick and easy way to add documentation to your PHP project
-------------------------------------------------------------

[](#a-quick-and-easy-way-to-add-documentation-to-your-php-project)

We all document our code with PHP [DocBlocks](https://en.wikipedia.org/wiki/PHPDoc) but we never seem to actually generate the documentation and add it to our project. Why? It simply takes too much time (over a minute), so we put it off till later, and later never comes.

But with PHPFUI/InstaDoc, you can document your site in about a minute (OK, maybe 2). The steps involved:

- Install PHPFUI/InstaDoc via Composer (30 seconds)
- Run installation script (30 seconds)
- Create document page (1 minute, 6 lines of code)

Two minutes to usable documentation with the following features:

PHPFUI/InstaDoc Features
------------------------

[](#phpfuiinstadoc-features)

- Always up to date, even with code that is not yet checked in.
- Send constructor information including parameters and default values to clipboard.
- Child and Parent class hierarchy clearly displayed and accessable.
- Quick access to highlighted PHP source with user selectable highlighting.
- Quick access to the file's git history for the local repo.
- Full support for @inheritDoc tag so child method docs are displayed correctly.
- Documents all projects loaded via Composer automatically.
- Tabbed documentation so you are not looking at irrelevant methods.
- Alphabetized everything, no more searching unalphabetized pages!
- Support for markdown and custom markdown pages.
- Ability to generate static html files for high volume sites.
- Add any local repo directories.
- Remove any Composer project you don't care about.
- 5+ line config compatible with all PHP frameworks, or standalone.
- Uses [Foundation CSS framework](https://get.foundation) for a great experience on mobile.

### Install PHPFUI/InstaDoc (requires PHP >= 8.0)

[](#install-phpfuiinstadoc-requires-php--80)

```
composer require phpfui/InstaDoc

```

### Run Installation Script

[](#run-installation-script)

Once installed, you need to run an installation script to copy static files to your public directory. From your project root, run the following:

```
php vendor/phpfui/instadoc/install.php yourPublicDirectory/subDirectory

```

Example: **php vendor/phpfui/instadoc/install.php public/PHPFUI** will add all needed files to public/PHPFUI, which will avoid any conflicts with your current files. You can specify any directory by using \\PHPFUI\\Page::setResourcePath, but PHPFUI is recomended to keep things simple.

### Create Document Page

[](#create-document-page)

PHPFUI/InstaDoc does not reply on any framework and can run on a standalone page. It is recommended that you do not make your documentation public, as PHPFUI/InstaDoc will display PHP source files. How you restrict access to the page is up to you. The following does not restrict access and is simply an example:

```