PHPackages                             cable8mm/document2 - 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. [CLI & Console](/categories/cli)
4. /
5. cable8mm/document2

ActiveProject[CLI & Console](/categories/cli)

cable8mm/document2
==================

The Document2 is to generate Laravel style documents to static website.

v0.4.1(2y ago)03MITHTMLPHP ^8.1

Since Apr 5Pushed 2y ago1 watchersCompare

[ Source](https://github.com/cable8mm/document2)[ Packagist](https://packagist.org/packages/cable8mm/document2)[ Docs](https://github.com/cable8mm/document2)[ RSS](/packages/cable8mm-document2/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (6)Dependencies (12)Versions (7)Used By (0)

Document2 - Documentation Generator
===================================

[](#document2---documentation-generator)

[![code-style](https://github.com/cable8mm/document2/actions/workflows/code-style.yml/badge.svg)](https://github.com/cable8mm/document2/actions/workflows/code-style.yml)[![run-tests](https://github.com/cable8mm/document2/actions/workflows/run-tests.yml/badge.svg)](https://github.com/cable8mm/document2/actions/workflows/run-tests.yml)[![Packagist Version](https://camo.githubusercontent.com/23636a4bb4a127ae2cf474312d870b55a9733586b4486fa5c4a335e80304d388/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6361626c65386d6d2f646f63756d656e7432)](https://packagist.org/packages/cable8mm/document2)[![Packagist Downloads](https://camo.githubusercontent.com/8667f8f9390ba7e7b0dfec96a7034adb7c3e763ddb15cb37d781bf4cc5ee3172/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6361626c65386d6d2f646f63756d656e7432)](https://packagist.org/packages/cable8mm/document2/stats)[![Packagist Dependency Version](https://camo.githubusercontent.com/e97e6ec5cb02daf6f5c9ddefcc1482cd93a1210872f180d875c1e2df1c383fc2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6361626c65386d6d2f646f63756d656e74322f706870)](https://packagist.org/packages/cable8mm/document2)[![Packagist Dependency Version](https://camo.githubusercontent.com/3ec6e0a01e076a173bef792666821e3be666996eb775e8a8b629229887126583/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6361626c65386d6d2f646f63756d656e74322f6c61726176656c2d7a65726f2532466672616d65776f726b)](https://camo.githubusercontent.com/3ec6e0a01e076a173bef792666821e3be666996eb775e8a8b629229887126583/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646570656e64656e63792d762f6361626c65386d6d2f646f63756d656e74322f6c61726176656c2d7a65726f2532466672616d65776f726b)[![Packagist Stars](https://camo.githubusercontent.com/ae748a118dfb6fc42a314664059d6cd360da2c5f8ef3b0766dba07e968e4e5b5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f73746172732f6361626c65386d6d2f646f63756d656e7432)](https://github.com/cable8mm/document2/stargazers)[![Packagist License](https://camo.githubusercontent.com/b8be3a43c6957c96c06c1c1d3eb1c0ad1b36f6851bb21865348fa675074f575a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6361626c65386d6d2f646f63756d656e7432)](https://github.com/cable8mm/document2/blob/main/LICENSE.md)

The Document2 is to generate Laravel style documents to static website.

We have done our best to create a convenient tool for you all. Take a moment to see how it works.

Features
--------

[](#features)

- Generate static website from documentations
- Versions are supported
- Templates are supported
- Testing available locally
- Dark theme is supported
- Skeleton Theme is supported
- Search is supported
- Publish GitHub Pages with actions
- SEO is supported

Installation
------------

[](#installation)

```
composer install cable8mm/document2
```

Usage
-----

[](#usage)

Three official three templates are available. We can introduce them for creating as soon as possible.

Select your template:

```
bin/install-theme.sh https://github.com/cable8mm/laravel-theme
```

And clone the documentation files:

```
bin/checkout_latest_docs.sh
# Import laravel documentations into `docs` folder
```

Finally, run the following command to generate the static htmls

```
./document2
# Generate the static html files into the `public` folder

./document2 -d docs -b 10.x -f artisan.md
# Generate the static html file of directory `docs`, branch `10.x` and filename `artisan.md`
```

If Laravel Valet or Laravel Herd has been installed, you can visit .

Development Templates
---------------------

[](#development-templates)

### Create

[](#create)

```
cd templates

npm run dev
```

and visit . The port can be different.

### Reserved Placeholders

[](#reserved-placeholders)

```
{{ section_title }} : replaces the section title
{{ title }} : replaces the title
{{ version }} : replaces the documentation version
{{ canonical }} : replaces the canonical url of the documentation
{{ app_url }} : replaces the documentation url
{{ original_url }} : replaces the original website url out of docs

```

### Reserved Dividers

[](#reserved-dividers)

```

The navigator html is inserted in this area

The option html is inserted in this area

The markdown documentation html is inserted in this area

```

Testing
-------

[](#testing)

```
composer test
```

Formatting
----------

[](#formatting)

```
composer lint
# Modify all files to comply with the PSR-12.

composer inspect
# Inspect all files to ensure compliance with PSR-12.
```

License
-------

[](#license)

The Document2 project is open-sourced software licensed under the [MIT license](LICENSE.md).

###  Health Score

20

—

LowBetter than 14% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

6

Last Release

763d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c910c874a0263a18f9f976273054cd45faa3ffbcba7891992f4ab52d0656dd93?d=identicon)[Sam Lee](/maintainers/Sam%20Lee)

---

Top Contributors

[![cable8mm](https://avatars.githubusercontent.com/u/2672043?v=4)](https://github.com/cable8mm "cable8mm (30 commits)")

---

Tags

cliconsolegeneratormarkdowndocument

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/cable8mm-document2/health.svg)

```
[![Health](https://phpackages.com/badges/cable8mm-document2/health.svg)](https://phpackages.com/packages/cable8mm-document2)
```

###  Alternatives

[illuminate/console

The Illuminate Console package.

12944.1M5.1k](/packages/illuminate-console)[nunomaduro/laravel-console-menu

Laravel Console Menu is an output method for your Laravel/Laravel Zero commands.

815412.0k48](/packages/nunomaduro-laravel-console-menu)[mehrancodes/laravel-harbor

A CLI tool to Quickly create On-Demand preview environment for your apps.

9989.0k](/packages/mehrancodes-laravel-harbor)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)