Wiki — wiki pages for your forum

Karl

A wiki extension for Flarum 2.0.

Install: composer require linkrobins/wiki, then enable it in the admin Extension Manager (or install it straight from Packagist there).

Source & issues: https://github.com/linkrobins/wiki

Found a bug or want a feature? Reply here, or open an issue on the repo.

Karl

Wiki v1.1.0 is out. Full notes: https://github.com/linkrobins/wiki/releases/tag/v1.1.0

A few quality-of-life additions this release:

New

"Load more" buttons on article comments and revision history, so long articles and edit histories no longer load everything at once.
Empty article titles are now caught and rejected with a clear message instead of saving a blank article.
If you also run Font Sizer, the wiki index and article headings follow its reading-size setting.

Fixed

Cleaned up some dead code, and regenerated a lockfile that had been corrupted when Wiki was first split out of Support.

Behind the scenes, Wiki now has a full automated test suite and runs against PHP 8.3 to 8.5 and five databases on every change.

Karl

Wiki v1.2.0 is out. Full notes: https://github.com/linkrobins/wiki/releases/tag/v1.2.0

This release adds a table of contents for your articles.

New

Longer articles now show a "Contents" panel beside them, built automatically from the article's #, ## and ### headings. It stays in place as you scroll, highlights the section you're currently reading, and clicking an entry jumps straight to it.
A new "Table of contents" section in the admin settings, where you can turn the panel on or off for the whole wiki (it's on by default) and set how many headings an article needs before the panel appears, so short articles stay clean.

Good to know

On narrow screens the panel moves to the top of the article instead of the side.
If you also run Font Sizer, the contents panel scales along with the reading-size setting.
Every label is translatable.

Updates

Wiki v1.2.1 is out.

This is a small housekeeping release: the extension's GitHub repository has a new home at linkrobins/flarum-wiki, and the package's issue and source links now point there. Nothing about the extension itself changed, so there is no rush to update.

The package name is the same as always: you install and update it as linkrobins/wiki.

Full notes: https://github.com/linkrobins/flarum-wiki/releases/tag/v1.2.1

Update with composer update linkrobins/wiki.

Updates

Wiki v1.3.0 is out. Full notes: https://github.com/linkrobins/flarum-wiki/releases/tag/v1.3.0

This release fixes two display problems reported by the community and adds a new permission.

Fixed

Code blocks in wiki articles and comments now look the same as they do in regular forum posts, including syntax highlighting. Before this, the highlighter never ran on wiki pages, so code came out plain.
On phones, an article with a wide code block or table no longer stretches past the edge of the screen. Wide content scrolls inside its own box instead, just like in discussions.
If you also run Font Sizer, article titles on small screens now follow the reading-size setting like the rest of the page.

New

A "View wiki article revision history" permission in the admin permission grid. Everyone can view history by default, exactly as before, but you can now limit it to members or specific groups. Users without the permission simply don't see the History section on articles.

Thanks to Stezkoy on the Flarum community forum for the reports.

Update with composer update linkrobins/wiki.

Updates

Wiki v1.3.1 is out. Full notes: https://github.com/linkrobins/flarum-wiki/releases/tag/v1.3.1

A small follow-up to v1.3.0: the "Wiki" link in the forum sidebar now sits directly below the "Tags" item instead of above it, so the main navigation reads more naturally on forums that use tags. If you don't run the tags extension, nothing changes.

Update with composer update linkrobins/wiki.

Updates

Wiki v1.3.2 is out. Full notes: https://github.com/linkrobins/flarum-wiki/releases/tag/v1.3.2

A follow-up to v1.3.1's navigation change: on wiki pages the sidebar could show the shared forum links in a different order than the rest of the forum, with Wiki and Support pushed below the divider. The navigation now reads the same on every page: the forum links first (with Wiki below Tags), then the wiki's own section under a divider.

Update with composer update linkrobins/wiki.

Updates

v1.4.0 is out, with the features most requested in the community thread:

Readable article URLs. Articles now get a URL slug from their title (like /wiki/getting-started instead of /wiki/12), and you can set your own while writing or editing. All existing numeric links keep working, and the update migration gives your existing articles slugs automatically.
A FAQ section for articles. Add optional questions and answers on the article form and readers get a collapsible FAQ under the article. Articles without entries look exactly as before, and the section ships structured data so search engines can show the questions as rich results.
Contents you can reach anywhere on mobile. On phones the table of contents is now a compact bar pinned below the forum header: tap it to unfold the sections from wherever you are in the article.
Fixed: the "this article is deleted" notice editors see was nearly invisible on light themes.

This release adds database migrations, so run php flarum migrate and php flarum cache:clear after updating.

Full notes: https://github.com/linkrobins/flarum-wiki/releases/tag/v1.4.0