Site settings - Flowershow

Info

Some features are only available on the premium plan.

Name

Change your site’s name. If you don’t have a custom domain set, it will be used in your site’s URL: https://my.flowershow.app/@<your-username>/<site-name>

site-name-option

Root Directory

Set the path to the folder in your GitHub repository that you want to publish. For example, if you have a repository with your app's code and you want to publish only it's documentation stored in /docs, you can specify that folder here.

Leave this field empty if you want to publish the entire repository.

root-dir-option

Syntax Mode

Choose how Flowershow parses your content, as regular Markdown or as MDX. Use "auto" for auto-detection based on file extension.

syntax-mode-config

👉 See Syntax mode to learn more.

Auto-Sync

Automatically publish your site whenever you commit changes to your GitHub repository.

auto-sync-option

Comments

Show a comments section at the bottom of your pages.

comments-option

👉 See Comments to learn more.

Custom Domain (⭐️ Premium feature)

Set a custom domain for your site.

custom-domain-option

👉 See Custom domain to learn more.

Full-Text Search (⭐️ Premium feature)

Enable content indexing and display a search field in the navigation bar to help visitors find information more easily.

👉 See Full-text search to learn more.

Password Protection (⭐️ Premium feature)

Limit access to your site by requiring a password.

password-protection-option

Analytics

Enable Google Analytics tracking by adding an analytics field to your config file.

{
  "analytics": "G-XXXXXXXXXX" // Your GA4 Tracking ID
}

👉 See Analytics to learn more.

Favicon (⭐️ Premium feature)

Set your site's favicon by specifying the path to your favicon file in the favicon field of your config file. You can also use an emoji!

{
  "favicon": "/path/to/favicon.ico"
  // or "favicon": "🐶"
}

Customize your site's navigation bar. You can set the logo, title, links and more.

{
  "nav": {
    "logo": "/path/to/logo.png"
  }
}

👉 See Navigation bar to learn more.

Show your site's sitemap in a sidebar on the left.

{
  "showSidebar": true
}

👉 See Sidebar to learn more.

"Edit this page" links

Works only for sites published from public GitHub repositories.

Show "Edit this page" links at the bottom of your site's pages to allow visitors to contribute to your content easily. Links will open the underlying files in edit mode in your GitHub repository.

{
  "showEditLink": true
}

👉 See "Edit this page" links to learn more.

Excluding files from publishing

Control which files and directories are published.

{
  "contentExclude": [
    "/private-folder",
    "/draft-file.md"
  ]
}

👉 See Content filtering to learn more.