PHPackages                             zzfly256/markdown-to-site - 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. zzfly256/markdown-to-site

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

zzfly256/markdown-to-site
=========================

A tool to build up documents website by instantly reading markdown files

04PHP

Since Sep 13Pushed 7y ago1 watchersCompare

[ Source](https://github.com/zzfly256/markdown-to-site)[ Packagist](https://packagist.org/packages/zzfly256/markdown-to-site)[ RSS](/packages/zzfly256-markdown-to-site/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Markdown to Site
================

[](#markdown-to-site)

Version: 20180913

Author: Rytia

Github: [zzfly256/markdown-to-site](https://github.com/zzfly256/markdown-to-site)

Description
-----------

[](#description)

A tool to build up website by instantly loading the remote or local markdown files instantly.

You can use it to build up some useful sites that synchronizes content from your github such as:

- Simple blog
- Developing documents
- Wiki

Install
-------

[](#install)

### Requirement

[](#requirement)

- PHP (7.0+ is better)
- composer

### Download and install

[](#download-and-install)

After installing your composer, you can do the follows in your console:

```
git clone https://github.com/zzfly256/markdown-to-site.git
cd mark-to-site
composer install
```

or, you can install it via composer directly:

```
composer create-project zzfly256/markdown-to-site
```

### Config

[](#config)

Just change the line 12 in `index.php` to your markdown file path. Here are demo:

```
// load the remote file
$file = file("https://raw.githubusercontent.com/php-quickorm/documents/master/README.md");

// load the local file
$file = file("/home/Rytia/readme.md");

// load file frome GET method
$file = file($_GET['md']);
```

Usage
-----

[](#usage)

Set your root directory to the `markdown-to-site` and access it via `http://your_ip/`.

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity3

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 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/cdd090dbe3975932cec15b36e0b0d2ccc4760838969fde448ea440d0e75c31e4?d=identicon)[Rytia](/maintainers/Rytia)

---

Top Contributors

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

### Embed Badge

![Health badge](/badges/zzfly256-markdown-to-site/health.svg)

```
[![Health](https://phpackages.com/badges/zzfly256-markdown-to-site/health.svg)](https://phpackages.com/packages/zzfly256-markdown-to-site)
```

###  Alternatives

[ferdiunal/nova-editable-field

A Laravel Nova package to make fields editable.

104.6k](/packages/ferdiunal-nova-editable-field)

PHPackages © 2026

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