Pages generator

clarkwinkelmann

This package allows you to define static routes in Flarum that will be rendered from Markdown or HTML files automatically. It's not a Flarum extension. It needs to be manually configured as a local extender.

At the moment the extender can only be called once so I don't recommend anyone try to add this as a dependency of a public extension as it would prevent adding additional local routes. But I am considering this as a use case for the future 1.0 release.

I have tagged a first beta release 0.1. I will probably release a breaking change update 0.2 with a more advanced API in the near future.

Current features:

Generate page from Markdown/bbcode (using forum formatter)
Generate page from HTML
Page title set in front matter
URL generated from filename/folder
Ability to embed simple Mithril components

Planned features:

Custom URL different from filename
Customizable OG tags
Extendable and custom page templates
Page template options (hero, side navigation, ...)
Multi-language
- Ability to specify source folder language
- Automatic redirect to the page with the same name in a different language when switching locale, even if the URL differs
- Redirect URLs that don't exist in the current language to their correct localized version
Ability to nest Mithril components or pass HTML as component children
Mithril component support without the use of eval

The documentation is in the GitHub README https://github.com/clarkwinkelmann/flarum-pages-generator

Suggestions welcome!

Hari

clarkwinkelmann so now flarum officially have something like gatsbyjs?

Wow. There it is 😍

Darkle

Hey Clark, I've been using this extension for a long time now, but until a few days ago I haven't had the opportunity to use a Mithril component (in this case the contact form).

I've tried to use it as it says in the GitHub repository, both in the extend.php, as in the page itself.

But for some reason I have not been able to get it to work, I get this console error:

forum.js?v=1da2ee39:1 TypeError: Cannot read properties of undefined (reading 'ContactForm')
    at eval (eval at <anonymous> (forum.js?v=1da2ee39:410:1051380), <anonymous>:1:38)
    at forum.js?v=1da2ee39:410:1051380
    at Array.map (<anonymous>)
    at Page.view (forum.js?v=1da2ee39:410:1051273)
    at Function.a (forum.js?v=1da2ee39:1:138663)
    at forum.js?v=1da2ee39:1:145102
    at p (forum.js?v=1da2ee39:1:145489)
    at f (forum.js?v=1da2ee39:1:141716)
    at forum.js?v=1da2ee39:1:144175
    at p (forum.js?v=1da2ee39:1:144380)

Does it work for you?

clarkwinkelmann

Darkle ContactForm is an example name. It's not part of the extension.

I didn't show how such a component would be exported because it's the standard Flarum export syntax.

The example assumes an extension with package name acme/basic-form has a src/forum/index.js file that looks something like this:

import Component from 'flarum/common/Component`;

export class ContactForm extends Component {
    view () {
        return m('form', 'Some stuff');
    }
}

The way Flarum works such an export would be made available as flarum.extensions['acme-basic-form'].ContactForm to other extension, which is then the value to copy in the component declaration in my extension.

Darkle

clarkwinkelmann Sorry I misunderstood, I thought it was included 😅 , I will definitely try to look at it in depth, it has a huge potential with some extensions, thanks for the note!