LR Wiki adds a wiki to your forum: public articles your members write and edit together, with full edit history.
What it does
- Public articles anyone can read. Members with permission write and edit them together.
- Categories with their own color and icon, and a home page that lists each one with its first few articles.
- Readable addresses like
/wiki/getting-started. Renaming an article keeps its old addresses working, so shared links never break.
- Full history. Every edit saves a revision, and you can see exactly what changed between versions.
- Drafts only you and wiki editors can see until you publish.
- A table of contents beside long articles that follows along as you scroll.
- FAQs under any article, as a list readers can expand.
- Related articles from the same category at the bottom.
- Comments under articles.
- Reports. Members can flag an article as wrong, out of date, off topic or a duplicate. Reports collect in the admin panel.
- Search inside the wiki, and articles also show up in the forum's own search.
- Articles use Flarum's formatting, so Markdown, BBCode, mentions and emoji all work.
Found by search engines
Every article is a real page with its title, description and full text sent with the page itself, so Google reads it even though Flarum is a JavaScript app. Links shared in chat apps show the title and description. If you have fof/sitemap, articles go in your sitemap, and with fof/seo it supplies the article metadata. Neither is required.
Permissions
Start articles, edit any article, comment, view history, and report, each grantable per group. Authors can always edit their own articles.
Requirements
- Flarum 2.0 or later, PHP 8.3+
Install
composer require linkrobins/wiki
Then enable it under Admin, Extensions, add categories in its settings, and grant the permissions.
Source: linkrobins/flarum-wiki
Packagist: https://packagist.org/packages/linkrobins/wiki
Every release is posted below.
