PHPackages                             johnsquibb/markdown-website - 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. [Framework](/categories/framework)
4. /
5. johnsquibb/markdown-website

ActiveProject[Framework](/categories/framework)

johnsquibb/markdown-website
===========================

A website framework that generates and caches pages from Markdown files.

02PHP

Since Jul 10Pushed 4y ago1 watchersCompare

[ Source](https://github.com/johnsquibb/markdown-website)[ Packagist](https://packagist.org/packages/johnsquibb/markdown-website)[ RSS](/packages/johnsquibb-markdown-website/feed)WikiDiscussions main Synced yesterday

READMEChangelogDependenciesVersions (1)Used By (0)

markdown-website
================

[](#markdown-website)

A website framework that generates and caches pages from Markdown files.

Built on [johnsquibb/php-microframework](https://github.com/johnsquibb/php-microframework).

Features
--------

[](#features)

- Automatic routing based on markdown directory and file structure.
- Caches complete static HTML web pages to cache directory when navigating the site.

Development Status
------------------

[](#development-status)

The framework is currently in development and subject to frequent change. A stable version with tagged release will be made available when ready.

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

[](#installation)

`composer create-project johnsquibb/markdown-website:dev-main`

Usage
-----

[](#usage)

Use the builtin PHP server to serve from the public directory during development:

`php -S localhost:8080 -t public`

Then visit:  to view the website.

Create markdown files and navigate the site to create or update the cache for each page.

### Testing static renders

[](#testing-static-renders)

To test static HTML cache renders:

`php -S localhost:8080 -t cache`

Then visit:  to view the static content.

**Note**: Copy assets from the `public` to `cache` directory to view custom assets, styles, scripts when testing static renders.

How caching works
-----------------

[](#how-caching-works)

While navigating pages in development mode, any found Markdown files will produce a web page. The complete HTML, including header and footer will be rendered into a static HTML file matching the file name and directory structure of the loaded Markdown file. All relative links will be suffixed with `.html` to faciliate connecting up other cached content.

Exporting cached files
----------------------

[](#exporting-cached-files)

Copy the contents of the cache directory to your website. Only the HTML is cached. Any assets in the public directory such as CSS, images, etc. must be manually copied to your website directory. A future version may support copying these files automatically.

[Learn more](http://johnsquibb.com/resources-for-building-static-websites.html) about hosting static HTML websites using Amazon S3.

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity29

Early-stage or recently created project

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://avatars.githubusercontent.com/u/1144045?v=4)[John](/maintainers/johnsquibb)[@johnsquibb](https://github.com/johnsquibb)

### Embed Badge

![Health badge](/badges/johnsquibb-markdown-website/health.svg)

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

###  Alternatives

[laravel/dusk

Laravel Dusk provides simple end-to-end testing and browser automation.

1.9k39.6M297](/packages/laravel-dusk)[nineinchnick/edatatables

Grid widget for the Yii Framework, wrapper for the DataTables jQuery plugin

173.2k](/packages/nineinchnick-edatatables)[link-cloud/fast-hyperf

LinkCloud Fast Hyperf

241.2k1](/packages/link-cloud-fast-hyperf)

PHPackages © 2026

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