PHPackages                             mrpunyapal/docsmith - 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 & Serialization](/categories/parsing)
4. /
5. mrpunyapal/docsmith

ActiveLibrary[Parsing & Serialization](/categories/parsing)

mrpunyapal/docsmith
===================

Craft static documentation sites from Markdown with minimal setup.

0.1.3(1mo ago)581↓75%MITPHPPHP ^8.3CI passing

Since May 29Pushed 1mo agoCompare

[ Source](https://github.com/MrPunyapal/docsmith)[ Packagist](https://packagist.org/packages/mrpunyapal/docsmith)[ RSS](/packages/mrpunyapal-docsmith/feed)WikiDiscussions main Synced 1w ago

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

Docsmith
========

[](#docsmith)

[![Latest Version on Packagist](https://camo.githubusercontent.com/8d01a0a2ea72193c93bd84fe060925540daa4c874e7d8702ac2cc09098a5c151/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6d7270756e796170616c2f646f63736d6974682e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/mrpunyapal/docsmith)[![Total Downloads on Packagist](https://camo.githubusercontent.com/53c7fbd217ae42af53960c2a95f7dc05ab47e5e452aa2ea89a31c7fa617e417b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6d7270756e796170616c2f646f63736d6974682e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/mrpunyapal/docsmith)[![CI](https://github.com/MrPunyapal/docsmith/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MrPunyapal/docsmith/actions/workflows/ci.yml)

Craft static documentation sites from Markdown with minimal setup.

Docsmith is designed for package and project documentation where you want a fast build flow, a clean default UI, and zero frontend setup.

Features
--------

[](#features)

- Build static HTML docs from Markdown
- Default output folder is docs for GitHub Pages workflows
- Searchable sidebar navigation
- Global search results powered by generated `search-index.json`
- Collapsible grouped navigation with active-page auto-open/scroll
- Optional right sidebar table of contents
- Configurable accent color with Laravel red as the default theme
- Syntax-highlighted fenced code blocks
- One-click copy button on code snippets
- Repository/edit links and previous/next page navigation
- Generated `search-index.json`, `sitemap.xml`, and `.nojekyll` artifacts
- Optional README index compatibility mode for existing repositories

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

[](#installation)

```
composer require --dev mrpunyapal/docsmith
```

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

[](#quick-start)

Create a build script (example: build-docs.php):

```