Download the PHP package petebishwhip/laradocs without Composer

On this page you can find all versions of the php package petebishwhip/laradocs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laradocs

Laradocs

tests quality Latest Version Total Downloads

Maintain beautiful, version-controlled documentation inside your Laravel codebase. Write markdown, commit it next to the code it describes, and Laradocs serves a polished docs site at /docs (or wherever you like).

Then open /docs.

Requirements

Minimum Notes
PHP 8.3 8.4 and 8.5 fully supported
Laravel 11.14 12 and 13 fully supported
dedoc/scramble 0.13 Optional β€” only needed for the scramble OpenAPI driver

Features

Quick start

Create a page:

Configuration

Everything is configurable in config/laradocs.php and via environment variables β€” route prefix/domain, docs path, routing strategy, theme, caching and more. See the Configuration docs.

The Laradocs facade

Artisan commands

Command Description
laradocs:install Publish config and scaffold a starter page
make:doc {name} Scaffold a new markdown page with front-matter
laradocs:cache Pre-render and cache every page
laradocs:clear Clear the documentation cache
laradocs:openapi Generate an OpenAPI spec from your routes (--driver=auto\|native\|scramble)

Publishing

Testing

Local development (workbench)

The package ships an orchestra/testbench workbench β€” a disposable Laravel app used to run Laradocs as a real, browsable site while you work on the package itself, rather than through Pest alone.

This builds the workbench (testbench workbench:build) and boots it at /docs. The generated app lives at vendor/orchestra/testbench-core/laravel β€” it's regenerated on demand and isn't committed to git.

By default the workbench has no docs content, so /docs renders an empty state. Point it at the real docs in this repo (so edits under docs/ show up immediately, thanks to Laradocs' mtime-based cache) by adding to the workbench's .env:

Or seed your own throwaway fixtures directly under the workbench's docs/ and lang/vendor/laradocs/<locale>/ β€” useful for exercising a specific feature (a locale, a version, a front-matter combination) without touching the real docs. Any config/laradocs.php option can be set via the workbench's own .env, exactly as in a consumer app β€” e.g. LARADOCS_LOCALE_AVAILABLE={"en":"English","fr":"FranΓ§ais"} to test localisation.

For finer control than composer serve gives you β€” e.g. driving the app with curl instead of a browser β€” build and serve it yourself:

Two gotchas worth knowing:

Documentation

The full docs live at laradocs.dev/docs β€” and are themselves built with Laradocs. Highlights:

The source for those pages lives in docs/; browse there or serve a local copy with composer serve.

Sponsors

Laradocs is free and open source. If it saves you time, please consider sponsoring its development β€” it keeps the project actively maintained.

The image above is regenerated daily by the Scheduler workflow via sponsorkit.

Contributing & Security

See SECURITY.md.

License

The MIT License (MIT). See LICENSE.md.

Star History

Star History Chart


All versions of laradocs with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
devizzent/cebe-php-openapi Version ^1.1
illuminate/contracts Version ^11.14 || ^12.0 || ^13.0
illuminate/support Version ^11.14 || ^12.0 || ^13.0
league/commonmark Version ^2.4
ralphjsmit/laravel-seo Version ^1.8
spatie/yaml-front-matter Version ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package petebishwhip/laradocs contains the following files

Loading the files please wait ...