PHPackages                             mnapoli/gh-pages-compiler - 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. [Utility & Helpers](/categories/utility)
4. /
5. mnapoli/gh-pages-compiler

AbandonedArchivedLibrary[Utility & Helpers](/categories/utility)

mnapoli/gh-pages-compiler
=========================

Markdown compiler for github pages

1494[2 issues](https://github.com/mnapoli/gh-pages-compiler/issues)JavaScript

Since Jan 17Pushed 12y ago1 watchersCompare

[ Source](https://github.com/mnapoli/gh-pages-compiler)[ Packagist](https://packagist.org/packages/mnapoli/gh-pages-compiler)[ RSS](/packages/mnapoli-gh-pages-compiler/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

*gh-pages-compiler* generates a website from your markdown documentation.

**This package is not maintained anymore. A more recent and complete version is here: [Couscous](https://github.com/mnapoli/Couscous).**

Introduction
------------

[](#introduction)

[Github pages](http://pages.github.com/) are good, but what do you do:

- if you want to write your documentation in **Markdown** and not in HTML?
- if you want your documentation to be transformed into a **website**?
- if you want to **keep the documentation with your code**, versioned in the repository?

*gh-pages-compiler* is here to help you. **Your documentation is written in Markdown, versioned in your repository with your source, compiled to HTML and published to *Github pages*.**

How does it work
----------------

[](#how-does-it-work)

1. you write your README and documentation in `.md` files (Markdown) on your repository
2. you generate you website with *gh-pages-compiler*

- it turns `.md` files into HTML files
- HTML files are committed to the `gh-pages` branch of your repository, and thus are published as a website by Github

3. profit!

Features
--------

[](#features)

- compiles Markdown using the same configuration as Github (to ensure correct results)
- full control over the website layout: you write your own template and menus
- supports any number of pages, images, links, Javascript (in the template), …
- hosted by GitHub on "Github pages", you don't have to host your website
- your README will be your home page, your code repository will always be in sync with your website

Read more
---------

[](#read-more)

- [Documentation](doc/)

Contribute
----------

[](#contribute)

Follow the project [on Github](https://github.com/mnapoli/gh-pages-compiler/)

Created by [Matthieu Napoli](https://github.com/mnapoli), using and inspired by:

- [Redcarpet](https://github.com/vmg/redcarpet)
- [This gist](https://gist.github.com/1300939) from [ralph](https://gist.github.com/ralph)

Examples
--------

[](#examples)

- [gh-pages-compiler](http://mnapoli.github.io/gh-pages-compiler/)
- [PHP-DI](http://php-di.org/)

###  Health Score

22

—

LowBetter than 22% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity41

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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/329a6111724074f5388e95dd41a03ccf3c43f4bfe1ecf27c94c9efc6f7823228?d=identicon)[mnapoli](/maintainers/mnapoli)

---

Top Contributors

[![mnapoli](https://avatars.githubusercontent.com/u/720328?v=4)](https://github.com/mnapoli "mnapoli (38 commits)")

### Embed Badge

![Health badge](/badges/mnapoli-gh-pages-compiler/health.svg)

```
[![Health](https://phpackages.com/badges/mnapoli-gh-pages-compiler/health.svg)](https://phpackages.com/packages/mnapoli-gh-pages-compiler)
```

###  Alternatives

[aaronfrancis/flaky

A Laravel package to elegantly handle flaky operations.

41524.8k](/packages/aaronfrancis-flaky)[cedaro/woocommerce-coupon-links

A WordPress plugin to automatically apply a WooCommerce coupon code to the cart with a URL.

13770.4k](/packages/cedaro-woocommerce-coupon-links)[execut/yii2-widget-bootstraptreeview

Bootstrap Tree View widget wrapper for yii2

46170.2k](/packages/execut-yii2-widget-bootstraptreeview)[mouf/classname-mapper

Provides a way to find in which PHP files a class will be looked upon.

112.3M5](/packages/mouf-classname-mapper)[tarfin-labs/zbar-php

zbar-php is a php package that provides an interface to the zbar bar-code reading library.

2593.2k](/packages/tarfin-labs-zbar-php)[fkr/simplepie-bundle

Integrates SimplePie into Symfony

11137.5k](/packages/fkr-simplepie-bundle)

PHPackages © 2026

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