ReadMe Documentation

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Landing Page

When you go to the Landing Page tab you can customize things such as the header and body content.

๐Ÿ“˜

"First Page" Setting

Make sure you have Landing Page set to first page under the Site Navigation > Advanced Settings. (see screenshot below)

Header

Promo Title
This will be the title text that goes into header.

Promo Text
This will be the text that goes underneath the promo title, but it will still display in the header.

Content
Underneath the promo title and text, you will have the option of having Nothing, Buttons, Search Bar, or Custom HTML. Custom HTML will override your promo title/text, so keep that in mind when editing.

Body

You have many templates for your body content and you can add more than one if you want to display multiple templates on your landing page.

Important Links
This will be the default if you do not select any of the options. It will display documentation, announcements, and the forums.

๐Ÿšง

If you have any of these three features disabled, you should not use a Landing Page as it will link your users to a 404 page.

Documentation categories
This simply lists all your categories with quick links to doc pages. You can also choose to display the reference section.

Three columns of text, text, text + media
These let you add the text yourself that you want displayed, and upload an image.

Custom HTML
If none of these suit your needs, you can always add custom HTML to get it exactly how you want it.

The Landing Page can be enabled or disabled in your Project Dashboard under Appearance > Enable/Disable sections

โ—๏ธ

Disabling Landing Page

The Landing Page is shared across all versions. If you disable the Landing Page it will be removed everywhere.


Did this page help you?