👍

View this article as a Custom Page

Use Custom Pages when you want to keep your ReadMe project's top navigation but customize everything below the search bar.

What's different?

Custom Pages change a few things compared to standard Documentation pages:

1. No left sidebar navigation
2. No table of contents, even if headers are used
3. A different URL path (/page instead of /docs)
4. No page voting
5. No "Updated x days ago"

🚧

Custom Pages are not affected by versioning and are shared. If you delete a Custom Page it will be removed from everywhere.

What's the same?

You can add a Custom Page to your subnavigation in Admin Settings > Navigation. It will appear as a new item using the same header name or a custom title.

Modes

Custom Pages support two modes:

1. Markdown: The standard mode used in the Documentation section
2. HTML: HTML is sanitized. If you want to include CSS or JavaScript, do so in Appearance > Custom CSS/JS instead.