Content Structure
Learn how to manage and organize your project's content.
The top-level organization of your project content is organized by sections. When you first create a project, ReadMe will automatically start you off with our most frequently-used sections: Guides, API Reference, and Changelog.
Changelog, Recipes, Discussions, and Custom Sections are only available on paid plans
Create a section
- In your editor, click on "Add Section"
- Select the type of section you want to add. Currently, you can add only Guides and API Reference sections more than once per project.
-
If you create a duplicate section, enter an icon, label, and directory name for the section. You can set the directory name only once, so choose carefully.
Currently, you can add Guides and API Reference sections more than once per project.
Each type of section includes bespoke functionality that makes the section unique. Learn more about these types of sections.
Transform complex concepts into clear, engaging documentation and tutorials
Interactive technical guide to help developers understand your API
Keep end-users up to date with your latest changes and announcements
Illustrate intimidating code blocks through step-by-step walkthroughs
Change section visibility
All sections are public by default, meaning that they will be visible on your project navigation and accessible to all viewers. To change the visibility of a section:
- Open the section's action menu by hovering over the section item in the sidebar
- Use the "Visibility" setting to set your desired visibility. We offer two settings:
- Public: Section is on the project navigation and its content is accessible for all viewers
- Admins and Editors: ReadMe hides the section navigation item and content from viewers. Only your project's admins and editors can access them.
You can add sections on a branch, making it possible to edit and review with your team without making your content public. When you're ready to publish, review and merge your content as usual. Learn more about branching.
Deleting a section
- Open the section's action menu by hovering over the section item in the sidebar
- Click Delete Section. Aside from Changelogs, deleting a section on a version will not affect that section on other versions or branches.
Changelog sections are not versioned. Deleting a Changelog will delete it from all versions and branches in your project.
Manage your site navigation
ReadMe automatically adds the sections you create to your project's site navigation. To reorder sections, or add additional items to your navigation (like external links or custom pages):
- Navigate to the Site Navigation panel in the editor
- Edit your project navigation by reordering, adding, and removing items. Changes you make to these settings on a branch will not be visible to your viewers until you review and merge.
Updated 3 minutes ago