Managing Documentation
Learn how to use the Editing UI's powerful management features to maintain and organize your documentation effectively.
Appearance Settings
![](https://files.readme.io/bba3ff7811671c7fe52457a5d9700820e29d004b42cbc6f4e462d0e04623cd5b-CleanShot_2024-11-08_at_19.33.572x.png)
Access Appearance Settings through the paintbrush icon to:
Theme Customization
![](https://files.readme.io/9d889bff0f3a072b076b8e948ced43e09ca741820fcdebd53e0b108db80c0d5b-CleanShot_2024-11-08_at_20.17.28.gif)
- Update your documentation's visual style.
- Modify colors and branding elements.
- Adjust typography settings.
Layout Management
- Configure navigation layout.
- Customize header and footer.
- Organize sidebar structure.
Preview Changes
- See updates in real-time.
- Ensure brand consistency.
Content Settings
![](https://files.readme.io/1474af0c2a3b40d6fd59c9ccf69bc18a72b40641bc81ad2a260a145da2d75982-CleanShot_2024-11-08_at_19.40.30.gif)
Access Content Settings through the content icon to manage reusable elements:
Reusable Content
![](https://files.readme.io/540cc3cdf9d64787d931fe56f723449c63c8e08e89b3282d27d1ef41bde9803d-CleanShot_2024-11-08_at_20.15.47.gif)
- Create content blocks that can be used across pages.
- Update shared content in one place.
- Maintain consistency throughout your docs.
Glossary Management
![](https://files.readme.io/d65ca7c2b7644e3d8d751efd5ed67bf219c497c9ea1a9e85ad668b679a740257-CleanShot_2024-11-08_at_19.47.19.gif)
- Add and edit glossary terms.
- Insert terms using
<<
shortcut. - Keep terminology consistent.
Version Control
![](https://files.readme.io/f111c4a85e748555d660a0455f9d2d740b1e1841928e4178c203c53dfd65a257-CleanShot_2024-11-08_at_19.50.242x.png)
Use the Versions dropdown in the top navigation to:
Managing Versions
![](https://files.readme.io/f6dcae43c70b13c814e8cdf90dabff32de64b564e81e3907b9843e31aa54426f-CleanShot_2024-11-08_at_20.21.59.gif)
- Switch between different documentation versions.
- Create new versions when needed.
- Archive outdated versions.
Version-Specific Content
- Maintain separate content for different versions
- Update version-specific examples
- Keep documentation synchronized with your API versions
Updated 3 months ago