Skip to content

Commit bbec64f

Browse files
committed
Customization fixes
1 parent 1e9fb19 commit bbec64f

File tree

15 files changed

+91
-990
lines changed

15 files changed

+91
-990
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ vendor/
66
*.cache
77
*.bat
88
phpunit.xml
9+
composer.lock
910

1011

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ But with PHPFUI\InstaDoc, you can document your site in about a minute (OK, mayb
1414
## PHPFUI\InstaDoc Features
1515
* Always up to date, even with code that is not yet checked in
1616
* Documents all projects loaded via Composer automatically
17-
* Add any local repo directories
18-
* Remove any Composer project you don't care about
17+
* Add any local repo directories
18+
* Remove any Composer project you don't care about
1919
* Custom ordering of types (const, static, public, protected, etc.)
2020
* Alphabetized everything, no more searching unalphabetized pages!
2121
* Support for markdown and custom markdown pages
@@ -32,9 +32,9 @@ composer require phpfui/InstaDoc
3232
### Run Installation Script
3333
Once installed, you need to run an installation script to copy static files to to your public directory. From the project root, run the following:
3434

35-
php vendor/phpfui/InstaDoc/install.php yourPublicDirectory/subDirectory
35+
php vendor/phpfui/instadoc/install.php yourPublicDirectory/subDirectory
3636

37-
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, but PHPFUI is recomended to keep things simple.
37+
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.
3838

3939
### Create Document Page
4040
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:
@@ -54,5 +54,4 @@ That is it. You are done!
5454

5555
* Create Doc page (the whole point, but do the easy stuff first!)
5656
* Add more documentation
57-
* Allow for customizable pages (not 100% yet)
5857
* .git page

0 commit comments

Comments
 (0)