https://github.com/lcharette/uf_markdownpages

Simple flat-file pages for UserFrosting 4
https://github.com/lcharette/uf_markdownpages

userfrosting userfrosting-sprinkle

Last synced: about 1 month ago
JSON representation

Simple flat-file pages for UserFrosting 4

• Host: GitHub
• URL: https://github.com/lcharette/uf_markdownpages
• Owner: lcharette
• License: mit
• Created: 2018-02-16T00:33:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2021-02-26T22:04:36.000Z (about 4 years ago)
• Last Synced: 2025-02-12T09:59:12.192Z (3 months ago)
• Topics: userfrosting, userfrosting-sprinkle
• Language: PHP
• Size: 161 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

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

[![Latest Version](https://img.shields.io/github/release/lcharette/UF_MarkdownPages.svg)](https://github.com/lcharette/UF_MarkdownPages/releases)

[![UserFrosting Version](https://img.shields.io/badge/UserFrosting->=%204.1.16-brightgreen.svg)](https://github.com/userfrosting/UserFrosting)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md)

[![Donate](https://img.shields.io/badge/Donate-Buy%20Me%20a%20Coffee-blue.svg)](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**

| Branch | Status |

| ------ | ------ |

| master | [![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://styleci.io/repos/121700467/shield?branch=master&style=flat)](https://styleci.io/repos/121700467)  [![codecov](https://codecov.io/gh/lcharette/UF_MarkdownPages/branch/master/graph/badge.svg)](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://styleci.io/repos/121700467/shield?branch=develop&style=flat)](https://styleci.io/repos/121700467) [![codecov](https://codecov.io/gh/lcharette/UF_MarkdownPages/branch/develop/graph/badge.svg)](https://codecov.io/gh/lcharette/UF_MarkdownPages)

# 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

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:

```json

{

    "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

* [Adding the page treeview to the sidebar](docs/SidebarTreeView.md)

* [Metadata](docs/Metadata.md)

* [Adding custom markdown blocks](docs/Extending-Parsedown.md)

# 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

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

# TODO

- Add basic permissions to pages

- Support multiple languages

- Support for partial file (folder starting with an underscore, ie `_header`)