lcharette / uf_markdownpages
Simple flat-file pages for UserFrosting 4
Fund package maintenance!
Ko Fi
Installs: 25
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 1
Forks: 0
Type:userfrosting-sprinkle
Requires
- lcharette/uf_breadcrumb: ^2.0.0
- pagerange/metaparsedown: ^1.0.3
This package is auto-updated.
Last update: 2024-11-27 06:50:17 UTC
README
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 site, directly inside UserFrosting.
This sprinkles requires UserFrosting 4.1 or newer
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 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:
{ "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
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. 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
)