PHPackages                             silverslice/markdown-api - 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. silverslice/markdown-api

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

silverslice/markdown-api
========================

Markdown documentation generator

v0.1.1(10y ago)015MITPHPPHP >=5.5

Since Jul 2Pushed 10y ago1 watchersCompare

[ Source](https://github.com/silverslice/markdown-api)[ Packagist](https://packagist.org/packages/silverslice/markdown-api)[ RSS](/packages/silverslice-markdown-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (3)Used By (0)

Tiny library for generating API documentation for your class
============================================================

[](#tiny-library-for-generating-api-documentation-for-your-class)

Install
-------

[](#install)

`composer require silverslice/markdown-api`

Live example
------------

[](#live-example)

```
require __DIR__ . '/../vendor/autoload.php';

$g = new Silverslice\MarkdownApi\Generator();
$g->generate('Silverslice\MarkdownApi\Generator')->output();
```

This code generates following documentation for class \\Silverslice\\MarkdownApi\\Generator:

### generate

[](#generate)

Generates markdown documentation for public methods in a specified class

```
generate($className)
```

*Parameters:*

- *string* $className - Fully qualified class name

*Returns:*

- *$this*

### save

[](#save)

Saves generated documentation to a file

```
save($fileName)
```

*Parameters:*

- *string* $fileName - The name of the file

*Returns:*

- *int* - The number of bytes that were written to the file, or false on failure

### output

[](#output)

Outputs generated documentation

```
output()
```

### setTemplate

[](#settemplate)

Sets file path for template of a method

```
setTemplate($file)
```

*Parameters:*

- *string* $file - Path to the template

*Throws:*

- *\\InvalidArgumentException* - If the file cannot be read

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity49

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 ~55 days

Total

2

Last Release

3919d ago

### Community

Maintainers

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

---

Top Contributors

[![silverslice](https://avatars.githubusercontent.com/u/6722542?v=4)](https://github.com/silverslice "silverslice (5 commits)")

---

Tags

documentationreflectiondocmarkdown

### Embed Badge

![Health badge](/badges/silverslice-markdown-api/health.svg)

```
[![Health](https://phpackages.com/badges/silverslice-markdown-api/health.svg)](https://phpackages.com/packages/silverslice-markdown-api)
```

###  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

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

Provides DocBook-like rendering of Markdown files.

8257.6k16](/packages/bookdown-bookdown)[dniccum/nova-documentation

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

37116.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.

2327.6k](/packages/dudo1985-wpdocgen)

PHPackages © 2026

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