PHPackages                             lcharette/uf\_markdownpages - 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. lcharette/uf\_markdownpages

ActiveUserfrosting-sprinkle[Utility & Helpers](/categories/utility)

lcharette/uf\_markdownpages
===========================

Simple flat-file pages for UserFrosting 4

225[5 issues](https://github.com/lcharette/uf_markdownpages/issues)PHP

Since May 29Pushed 5y ago1 watchersCompare

[ Source](https://github.com/lcharette/uf_markdownpages)[ Packagist](https://packagist.org/packages/lcharette/uf_markdownpages)[ RSS](/packages/lcharette-uf-markdownpages/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (4)Used By (0)

Markdown Pages Sprinkle for [UserFrosting 4](https://www.userfrosting.com)
==========================================================================

[](#markdown-pages-sprinkle-for-userfrosting-4)

[![Latest Version](https://camo.githubusercontent.com/6b48f6e570c7ee5b5c4f0d5f495497f9eb688db424942e06c648d5bc5551ed6e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f6c63686172657474652f55465f4d61726b646f776e50616765732e737667)](https://github.com/lcharette/UF_MarkdownPages/releases)[![UserFrosting Version](https://camo.githubusercontent.com/526571ad181a57173a85bf81f15faf441d51ef12e8c2d10c2ab4b04fc1108371/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5573657246726f7374696e672d2533453d253230342e312e31362d627269676874677265656e2e737667)](https://github.com/userfrosting/UserFrosting)[![Software License](https://camo.githubusercontent.com/074b89bca64d3edc93a1db6c7e3b1636b874540ba91d66367c0e5e354c56d0ea/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e737667)](LICENSE.md)[![Donate](https://camo.githubusercontent.com/b7dc459938f321309f24018c6839ab1a99d6f0233f063a741ce7be1f607b88f5/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f446f6e6174652d4275792532304d6525323061253230436f666665652d626c75652e737667)](https://ko-fi.com/A7052ICP)

Simple flat-file page manager for UserFrosting 4. Drop any markdown file in your sprinkle and access them directly inside your UserFrosting installation. Support custom templates and sprinkle priority. It's just like a mini [Grav](https://getgrav.org) site, directly inside UserFrosting.

**This sprinkles requires UserFrosting 4.1 or newer**

BranchStatusmaster[![Build Status](https://github.com/lcharette/UF_MarkdownPages/workflows/Build/badge.svg?branch=master)](https://github.com/lcharette/UF_MarkdownPages/actions?query=workflow%3ABuild) [![StyleCI](https://camo.githubusercontent.com/f3dbaae60a52dd40866fe069726c7dcb4fefdcd54c596d2dbea8feb19a90f816/68747470733a2f2f7374796c6563692e696f2f7265706f732f3132313730303436372f736869656c643f6272616e63683d6d6173746572267374796c653d666c6174)](https://styleci.io/repos/121700467) [![codecov](https://camo.githubusercontent.com/711abd5ba7ef0e859f7a3c8455b144c8586592a0a0e898fd7e08f795a6fff8a5/68747470733a2f2f636f6465636f762e696f2f67682f6c63686172657474652f55465f4d61726b646f776e50616765732f6272616e63682f6d61737465722f67726170682f62616467652e737667)](https://codecov.io/gh/lcharette/UF_MarkdownPages)develop[![Build Status](https://github.com/lcharette/UF_MarkdownPages/workflows/Build/badge.svg?branch=master)](https://github.com/lcharette/UF_MarkdownPages/actions?query=workflow%3ABuild) [![StyleCI](https://camo.githubusercontent.com/374fcec50fd6d7df5bf5560a71774b5469b963df47105cc60a1b5ec06f1e9a77/68747470733a2f2f7374796c6563692e696f2f7265706f732f3132313730303436372f736869656c643f6272616e63683d646576656c6f70267374796c653d666c6174)](https://styleci.io/repos/121700467) [![codecov](https://camo.githubusercontent.com/dc052c8ed113751a8425cb0238c63c6da93b8ac69abc1af50209e1d68a273319/68747470733a2f2f636f6465636f762e696f2f67682f6c63686172657474652f55465f4d61726b646f776e50616765732f6272616e63682f646576656c6f702f67726170682f62616467652e737667)](https://codecov.io/gh/lcharette/UF_MarkdownPages)Help and Contributing
=====================

[](#help-and-contributing)

If you need help using this sprinkle or found any bug, feels free to open an issue or submit a pull request. You can also find me on the [UserFrosting Chat](https://chat.userfrosting.com/) most of the time for direct support. You can also contribute to this sprinkle by buying me coffee.

Installation
============

[](#installation)

Edit UserFrosting `app/sprinkles.json` file and add the following to the `require` list : `"lcharette/uf_markdownpages": "^1.0.0"`. Also add `MarkdownPages` to the `base` list. For example:

```
{
    "require": {
        "lcharette/uf_markdownpages": "^1.0.0"
    },
    "base": [
        "core",
        "account",
        "admin",
        "MarkdownPages"
    ]
}
```

Run `composer update` and `php bakery bake` to install the sprinkle.

Features and usage
==================

[](#features-and-usage)

- [Adding the page treeview to the sidebar](docs/SidebarTreeView.md)
- [Metadata](docs/Metadata.md)
- [Adding custom markdown blocks](docs/Extending-Parsedown.md)

Running tests
=============

[](#running-tests)

This sprinkle comes supports automated testing. Before submitting a new Pull Request, you need to make sure all tests are a go. With the sprinkle added to your UserFrosting installation, simply execute the `php bakery test` command to run the tests.

Licence
=======

[](#licence)

By [Louis Charette](https://github.com/lcharette). Copyright (c) 2018, free to use in personal and commercial software as per the MIT license.

TODO
====

[](#todo)

- Add basic permissions to pages
- Support multiple languages
- Support for partial file (folder starting with an underscore, ie `_header`)

###  Health Score

15

—

LowBetter than 3% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity37

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

---

Top Contributors

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

---

Tags

userfrostinguserfrosting-sprinkle

### Embed Badge

![Health badge](/badges/lcharette-uf-markdownpages/health.svg)

```
[![Health](https://phpackages.com/badges/lcharette-uf-markdownpages/health.svg)](https://phpackages.com/packages/lcharette-uf-markdownpages)
```

PHPackages © 2026

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