PHPackages                             christhompsontldr/laravel-docit - 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. [Parsing &amp; Serialization](/categories/parsing)
4. /
5. christhompsontldr/laravel-docit

ActiveProject[Parsing &amp; Serialization](/categories/parsing)

christhompsontldr/laravel-docit
===============================

Static site generator for documentation using Markdown and Protocol UI.

v1.0.0(3d ago)013↑361.5%MITJavaScriptPHP ^8.2CI passing

Since Mar 19Pushed 3d agoCompare

[ Source](https://github.com/ChrisThompsonTLDR/laravel-docit)[ Packagist](https://packagist.org/packages/christhompsontldr/laravel-docit)[ Docs](https://github.com/ChrisThompsonTLDR/laravel-docit)[ RSS](/packages/christhompsontldr-laravel-docit/feed)WikiDiscussions main Synced today

READMEChangelog (1)DependenciesVersions (2)Used By (0)

Docit – Documentation Static Site Generator
===========================================

[](#docit--documentation-static-site-generator)

Docit builds Markdown documentation into a static site using Protocol UI. Output goes to a configurable directory (default `docs/dist`) —perfect for GitHub Pages, GitLab Pages, or any static hosting.

**Docs:** [christhompsontldr.github.io/laravel-docit](https://christhompsontldr.github.io/laravel-docit)

Quick Start
-----------

[](#quick-start)

Add a `docit` script to your repo or package's `composer.json`:

**Composer-installed docit** (`vendor/christhompsontldr/laravel-docit`):

```
{
  "scripts": {
    "docit": "php vendor/bin/build-docs"
  }
}
```

**Monorepo** (docit at `packages/laravel-docit`):

```
{
  "scripts": {
    "docit": "php packages/laravel-docit/bin/build-docs"
  }
}
```

Then run:

```
composer docit
```

Or run the bin file directly: `php vendor/bin/build-docs` when installed via Composer, or `php packages/laravel-docit/bin/build-docs` in a monorepo.

GitHub Actions Integration
--------------------------

[](#github-actions-integration)

Docit includes a reusable workflow for building and deploying docs. Set repo **Settings → Pages → Source** to **GitHub Actions**.

### Option A: Reusable workflow (docit in monorepo)

[](#option-a-reusable-workflow-docit-in-monorepo)

When docit lives at `packages/laravel-docit` in your repo, add to `.github/workflows/docs.yml`:

```
name: Build and Deploy Docs

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  build:
    uses: ./packages/laravel-docit/.github/workflows/build-docs.yml
    with:
      docit-path: packages/laravel-docit
    permissions:
      contents: write
      pages: write
      id-token: write
```

### Option B: Composer-installed docit

[](#option-b-composer-installed-docit)

When docit is installed via Composer, create `.github/workflows/docs.yml`:

```
name: Build and Deploy Docs

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  build:
    uses: ChrisThompsonTLDR/laravel-docit/.github/workflows/build-docs.yml@main
    with:
      docit-path: vendor/christhompsontldr/laravel-docit
      base-path: /your-repo-name  # for GitHub Pages project sites
    permissions:
      contents: write
      pages: write
      id-token: write
```

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance99

Actively maintained with recent releases

Popularity8

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 95.8% 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

Unknown

Total

1

Last Release

3d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/bdadda5dda1f5a9711517509d5e552a699cd17fdac70fcc0ce7d364697d9cf0f?d=identicon)[ChrisThompsonTLDR](/maintainers/ChrisThompsonTLDR)

---

Top Contributors

[![ChrisThompsonTLDR](https://avatars.githubusercontent.com/u/348801?v=4)](https://github.com/ChrisThompsonTLDR "ChrisThompsonTLDR (23 commits)")[![Copilot](https://avatars.githubusercontent.com/in/1143301?v=4)](https://github.com/Copilot "Copilot (1 commits)")

---

Tags

documentationmarkdownstatic-site-generatorgithub pages

### Embed Badge

![Health badge](/badges/christhompsontldr-laravel-docit/health.svg)

```
[![Health](https://phpackages.com/badges/christhompsontldr-laravel-docit/health.svg)](https://phpackages.com/packages/christhompsontldr-laravel-docit)
```

###  Alternatives

[justinwalsh/daux.io

Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly

4.6k38.1k1](/packages/justinwalsh-dauxio)[daux/daux.io

Documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly

826188.8k1](/packages/daux-dauxio)[bookdown/bookdown

Provides DocBook-like rendering of Markdown files.

8256.9k13](/packages/bookdown-bookdown)[dniccum/nova-documentation

A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard.

37115.4k](/packages/dniccum-nova-documentation)[georgringer/doc

Render documentation based on markdown files directly in the backend

2232.7k](/packages/georgringer-doc)[dudo1985/wpdocgen

Documentation Generator for WordPress.

2326.5k](/packages/dudo1985-wpdocgen)

PHPackages © 2026

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