Download the PHP package foryoufeng/laravel-doc without Composer
On this page you can find all versions of the php package foryoufeng/laravel-doc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download foryoufeng/laravel-doc
More information about foryoufeng/laravel-doc
Files in foryoufeng/laravel-doc
Package laravel-doc
Short Description A tool for display docs or api docs to others
License MIT
Homepage https://github.com/foryoufeng/laravel-doc
Informations about the package laravel-doc
laravel-doc
中文文档
⛵laravel-doc
is doc generator for laravel which can help you write document by markdown and you can access it by web
Requirements
- PHP >= 7.0.0
- Laravel >= 5
Installation
Via Composer
If you do not run Laravel 5.5 (or higher), then add the service provider in config/app.php
:
You need to publish the resource files by run command
After run command you can find add many files in the project
to access the application
-
access
/doc
,to see the document -
access
/apidoc
,to see the api doc document - but they are write by Chinese language
How To Use
General document
create your md file in the resources/mds/docs
, such asdemo.md
,and add your content
then to theapp/Http/Controllers/Docs/LaravelDocController.php
,find the methodindex_md
to add data,such as:
access to /doc
Controller
the default path for docs to save
-
config menus
- after add your menus,add the
doc_link
you add to theresources/mds/docs
folder
api doc
create your md file in the resources/mds/apidocs
, such asdemo.md
,and add your content
then to theapp/Http/Controllers/Docs/LaravelApiDocController.php
,find the methodindex_md
to add data,such as:
access to /doc
laravel_doc.php
Advanced
-
Multi-project
to add more project you can copyapp/Http/Controllers/Docs
、resources/views/docs
,resources/mds/
and copy routes,then change it
-
i18n
change
languages
value in theconfig/laravel_doc.php
to set your own language,Provided by default isChinese
Change log
Please see the changelog for more information on what has changed recently.
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
License
MIT. Please see the license file for more information.