1. Customization

  2. /

  3. Site Settings

Site Settings

Configure and customize your documentation site through the Settings menu. These settings control your site's branding, domain, and other key features.

General

Site name and description

Set your site's name and description in General settings. Your site name appears in the navigation bar and browser tabs, while the description helps users understand the purpose of your documentation.

Homepage selection

Set any documentation page as your site's homepage. By default, your first documentation page serves as the entry point for your site.

Appearance

Add your brand logo in Appearance settings. For optimal display across devices and browsers, use a square image of at least 256×256 pixels in PNG, JPEG, or WebP format.

Last updated dates

Enable last updated dates to show when content was modified. This is especially useful for documentation that changes frequently or contains version-specific information.

Create a consistent footer for all documentation pages using the footer editor. Add contact details, helpful links, or legal information with formatted text and links.

Domain

Default domain

Your site comes with a *.playbookdocs.site domain and SSL security enabled. This domain is ready to use immediately.

Custom domain

Use your own domain for documentation by adding it in Domain settings. We'll guide you through the DNS setup and automatically handle SSL certificates. Read more about adding a custom domain.

Search Engine Optimization

Page titles and descriptions

Customize your page titles and descriptions in SEO settings to improve visibility in search results and help users understand your documentation's content.

Social preview image

Add a preview image for social media and chat app sharing. Use a 1200×630 pixel image that clearly represents your documentation or brand.

Sitemap

Enable sitemap generation in SEO settings to help search engines discover and index your documentation pages.

GitHub Integration

Keep your documentation in sync with your code by connecting your GitHub repository in Integrations settings. This allows you to:

  • Specify your documentation's location in the repository
  • Automatically update documentation when changes are merged
  • Monitor import history for successful updates

Advanced

Custom JavaScript

Add custom functionality to your site through the Advanced settings. Common uses include:

  • Analytics integration
  • Third-party tool connections
  • Custom features

Note that custom code may impact your site's loading performance.

Site Removal

Deleting pages

Remove specific documentation pages through the Destroy settings. Deleted pages cannot be recovered, so ensure you have necessary backups before proceeding.

Deleting your site

To permanently remove your site, use the Destroy setting. This action cannot be undone and will immediately make your content inaccessible.