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 — Flowershow's new List component makes it super easy to create blog index pages and other kind of listing pages for tutorials, recipes, and more.
Custom collection cards — Render custom cards for a collection of pages using normal HTML in the page body.
Custom Fonts — Learn how to enhance your site's typography with Google Fonts
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 simple markdown content into beautiful, JSX components styled with Tailwind CSS. We'll walk through the complete process using 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 comprehensive guide on setting up a blog on your Flowershow site — from creating a blog section to configuring the blog home page, adding authors, navigation, and applying 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

Reference

Analytics — Configure analytics for your Flowershow site using Google Analytics 4 or Umami.
Backlinks — Show a list of pages that link to the current page.
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 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 media icons.
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.
Math equations — Write math equestions 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.
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 title — Set the title of your page, both for display and for SEO
Password protection — Restrict access to your site with a password.
URL Redirects — Configure URL redirects to maintain backwards compatibility when moving or renaming pages.
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.
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
Themes — Change the look of your site in one line of config.

Agents

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.
Skills — Install the Flowershow skill to let your AI assistant publish and manage Flowershow sites — whether you publish via the fl CLI, a GitHub repository, or the Obsidian plugin.