Flowershow Docs Sitemap

An index of all documentation pages. Fetch this file to discover available docs without guessing URLs.

General

FAQs

Getting Started

Getting Started — Go from markdown files to a live website in under a minute.
Getting Started — Drag and Drop — Drop your markdown files and get a live site instantly — no account required.
Getting Started — From the Terminal (CLI) — Publish any folder of markdown from the terminal. No repo required.
Getting Started — From GitHub — Push to a repo, your site updates automatically.
Getting Started — From Obsidian — Publish directly from your Obsidian vault — no GitHub account needed.

Guides

Author Pages — Learn how to set up author pages to attribute content to your creators with links to custom profiles page and avatars.
Content Catalogs and Listing Pages — Create blog index pages and other listing pages for tutorials, recipes, projects and more, with a few lines of plain Markdown.
Custom Fonts — Use Google Fonts or your own font files on your site
Give your site a custom navbar and footer — Make your site look like your brand with your own navbar, footer, colors and fonts, using three small files.
Styling your site — Customize your site's appearance — colors, fonts, and more — using CSS variables and a single custom.css file.
Debugging 404 pages — Troubleshoot and fix 404 errors on your Flowershow site.
Debugging MDX Errors — Struggling with MDX errors? This guide explains the most common MDX parsing issues, how to avoid them, and how to fix them fast.
Enhancing Markdown Pages with Styled JSX Blocks — Learn how to transform plain markdown into beautiful JSX components styled with Tailwind CSS, walking through the complete process with a real-world example.
Newsletter and Subscription Forms — Learn how to integrate newsletter signup forms, contact forms, and surveys into your Flowershow site
Publishing a Blog — A complete guide to setting up a blog on Flowershow — create a blog section, configure the home page, add authors and navigation, and apply themes.
Publishing from the Terminal — A step-by-step tutorial covering installation, publishing, syncing changes, and managing your sites from the command line.
Publishing a GitHub Repo with Markdown — Learn how to publish your repository containing markdown files with Flowershow in 2 simple steps.
Publishing Your Obsidian Vault — Learn how to publish your Obsidian Vault quickly and easily using Flowershow. We'll go through four simple steps to get your notes online. Let's get started!
Publish Your Obsidian Vault with Enveloppe + Flowershow — Learn how to set up the Enveloppe plugin in Obsidian to publish your vault with Flowershow
Turn Your Obsidian Vault into a Blog with Flowershow — A step-by-step guide to turning your Obsidian vault into a published blog with Flowershow — sections, authors, navigation, and themes, all from Markdown.

Reference

Analytics — Configure analytics for your Flowershow site using Google Analytics 4 or Umami.
Annotations — Let colleagues select text on your published pages and leave notes, with no account. Then give the open notes to your AI agent with fl annotations pull.
Apply a theme — Apply one of Flowershow's themes from the dashboard or config.json, and customize it further.
Backlinks — Show a list of pages that link to the current page.
Changelog — Publish a changelog: Flowershow turns a changelog folder or a CHANGELOG.md file into a timeline page automatically
Flowershow CLI — Learn how to use the Flowershow CLI to publish your notes directly from your terminal.
Comments — Enable comments on your site's pages. Powered by Giscus and GitHub Discussions.
config.json file — Reference for all available options in the config.json site configuration file.
Content filtering — Control which files and directories get published
Custom domain — Connect your own domain to your Flowershow site
Custom favicon — Set a custom favicon for your site using an image file or an emoji.
Custom Head Code — Inject custom scripts, meta tags, and other HTML into the of every page on your Flowershow site.
Custom styles — Customize the appearance of your site with CSS.
Dark Mode — Enable and configure light/dark theme switching for your Flowershow site.
"Edit this page" links — Display an "Edit this page" link at the bottom of each page that takes users directly to the file in your GitHub repo, ready for editing.
Footer configuration — Customize your site footer with navigation links and social icons, replace it with your own HTML, or hide it on a page.
Forms — Embed newsletter signups, contact forms, and surveys in your pages.
Using Frontmatter Fields as Variables in Page Content — Reference frontmatter fields as variables anywhere in your MDX page content — reuse values, build dynamic links, render lists, and more.
Hero sections — Add prominent, full-width banners at the top of your pages that can include titles, descriptions, background images and call-to-action buttons.
Home page — How Flowershow resolves which file to show at the root of your site.
Knowledge Graph — Show an interactive graph of how your notes connect to each other.
List component — Create organized lists and content catalogs by automatically listing files in a specified directory.
Listing pages — A blog index, a grid of projects, a compact archive, a team page or the latest posts on your home page, from any folder, in plain Markdown.
Math equations — Write math equations with LaTeX syntax.
Mermaid diagrams — Create diagrams and visualizations using a popular, text-based syntax.
Navbar configuration — Set logo, title, links and socials in your navigation bar, replace its content with your own HTML, or hide it on a page.
Obsidian Bases Syntax (Beta) — Detailed reference for Obsidian Bases syntax, including filters, formulas, and view types.
Obsidian Canvas — Render Obsidian Canvas (.canvas) files as visual diagrams on your Flowershow site.
Page authors — Create dedicated profile pages for authors of your content and list them in page headers
Page headers — Configure page headers and SEO meta tags.
Page scripts — Load your own JavaScript on a single page with the scripts frontmatter field. Runs on every visit, including when readers navigate within your site.
Page title — Set the title of your page, both for display and for SEO
Password protection — Restrict access to your site with a password.
Post pages — Every post in your blog gets a reading column, a header with the author and date, the cover image, and links to the previous, next and related posts. Nothing to configure.
URL Redirects — Send visitors from old URLs to new ones when you move or rename pages, including whole folders at once.
Custom robots.txt — Control how search engines crawl your Flowershow site by publishing a robots.txt file from your vault.
RSS Feed — Enable an RSS feed for your site so readers can subscribe to your content.
SEO and social media metadata — Configure SEO titles, descriptions, and social media images for better search and sharing.
Sidebar Configuration — Enable sidebar navigation that displays your site's structure.
Social links — Add social media icons to your site's navbar and footer.
Supported file types — Which files Flowershow renders as themed pages, which it serves as-is, the URL each one gets, and the limits on a publish.
Syntax Mode Configuration — Configure whether your content is parsed as Markdown or MDX, globally or per page.
Markdown syntax support — Overview of Markdown syntax supported by Flowershow, including CommonMark, GitHub Flavored Markdown, and Obsidian extensions.
Table of contents — Control visibility of the page table of contents
Tags — Organize your notes with Obsidian-style tags — declared in frontmatter or inline as #tag — and browse them through automatically generated tag pages.
Semantic theme class reference — Stable Flowershow CSS hooks grouped by the UI areas that emit them.
Themes — Browse Flowershow themes and preview each one live before you apply it.

Agents

Publishing HTML — How to publish HTML pages and sites with Flowershow, standalone or inside Markdown pages. Written for AI agents and the people using them.
Markdown access — Every page on a Flowershow site is also served as raw markdown. Append .md to any URL to get clean, agent-readable content.
Publish from Claude and ChatGPT (beta) — Add Flowershow as a connector in Claude or ChatGPT, then ask it to publish what you've made. You get a live website link, with no account needed.
Skills — Install the Flowershow skill so your AI assistant can publish and manage Flowershow sites — via the fl CLI, a GitHub repository, or the Obsidian plugin.
Supported agents — Which AI agents can use the Flowershow skill, how to install it in each (one file, no Node.js needed), and what each agent can do.