Reader Mode

[Discourse]

	Summary	Reader Mode enables a focused reader experience within Discourse topics
	Preview	Preview on Discourse Theme Creator
	Repository	https://github.com/discourse/reader-mode
	New to Discourse Themes?	Beginner’s guide to using Discourse Themes

Install this theme component

As this is an official theme component maintained by the Discourse team, support, bug, ux, and feature requests can be made in the respective categories here on Meta, and tagged with the appropriate theme component tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

Features

This theme component adds a “reader mode” button to the topic timeline. “Reader mode” places the emphasis on the written word and lets the other UI elements fade into the background for a more focused reading experience. Users also have the option to choose from various fonts, adjust text size and reading width, and change to their preferred background colour

Settings

Name	Descriptions
svg icons

Hosted by us? Theme components are available to use on our Standard, Business, and Enterprise plans.

Last edited by @JammyDodger 2024-06-13T23:03:38Z

Check document

Perform check on document:

[Jagster (Jakke Lehtonen)]

I really love option to change font size

Bummer that component is not for mobiles.

[Tris20 (Tristan)]

Happy to see this officially released

Is it possible to match the fonts in reader mode to the font-list of the platform? For example, we’re using Open Sans, but that’s not an option on the font dropdown for Reader Mode. Would be a nice touch to have the same list of fonts to choose from.

---

Edit: I’m also noticing that topics which use Discourse TOC, but do not have a reply are not showing the Reader Mode Icon.

You can see an example here:

Why does Discourse always install "beta" versions by default?

In Discourse, four primary release channels serve different purposes: main, tests-passed, beta, and stable. The default channel used when installing a production version of Discourse is tests-passed. Our nomenclature differs a bit from other software companies and will be explained here. main This channel represents the latest development version of Discourse. It contains the most recent features and improvements but may not be thoroughly tested and can be unstable, so it is not recommended …

However as soon as there is at least one reply, the Timeline, ToC and Reader Mode seem to appear as expected.

[putty (Derek Putnam)]

Am I crazy? I don’t see the icon that is included in the topics’s screenshot:

[Moin]

@putty

Am I crazy

Probably not!

Just try a different theme (I would recommend default, meta branded or air)

[putty (Derek Putnam)]

Ah, yep, that solved it. Thank you

[JammyDodger]

I’ve added it to all the themes now. Not sure if it was missed off some on purpose but I’ll wait for the complaints to roll in to find out.

[Arnold (Jimmy)]

Could you add the function for guests too? Currently it’s only for registered and logged in Users.

An implementetion for mobile also would be great.

Thanks for this great component

[hoangphuctran93 (Hoàng Phúc Trần)]

Yes, I also hope that in the next updates this theme component will support user options on the phone.