Flowershow 🌷

Publish your Obsidian notes, beautifully. For free, no coding.

Flowershow is an open-source tool for easily converting your markdown files into an elegant website. It's built on a standard, modern web stack – React, Next.js, and Tailwind and shipped with a basic default theme to get you started with just a few clicks.

• Crafted for Obsidian, Flowershow works with your Obsidian vault out of the box. No need to modify the syntax or change the file layout. If you're not an Obisidan fan, Flowershow can be used with any CommonMark or GFM files.
• Elegant and functional default theme with basic front page and navbar.
• Easy to tweak and extend with custom page layouts and custom React components, that can be used within your markdown.
• Backed by a team of data geeks, who love Markdown, and are passionate about sharing knowledge and ideas with others.

👉 See Flowershow in action on Flowershow.app

Docs

• QuickStart
• Guides
• Roadmap

Features

Here are some of the cool features that are currently supported by Flowershow, and some that are still under development.

✅ Markdown

Flowershow supports CommonMark and GitHub Flavoured Markdown (GFM) syntax, e.g. code blocks, blockquotes, lists, tasks lists, and tables.

👉 Learn more

✅/🚧 Obsidian extensions to Markdown

Flowershow has been designed with Obsidian users in mind, and so it aims to support the whole suite of Obsidian syntax extensions, like:

• internal links ✅,
• callouts 🚧,
• math ✅,
• or Mermaid diagrams ✅

👉 Learn more

✅ Custom page layouts and components

You can customize and create new layouts for your pages.

👉 Learn more

Also, thanks to MDX support, you can use custom React components within your markdown notes.

👉 Learn more

✅ Tailwind support

Tailwind support makes it easy to style your in-markdown HTML and custom React components.

👉 Learn more

🚧 Knowledge graph

Interactive knowledge graph to see how your notes are interconnected.

🚧 Notes previews

Wikipedia-like internal links previews on hover.

🚧 Themes

A set of different starter themes to choose from and support for dark/light mode.

🚧 Forward links and Backlinks

Lists of forward links used on the page and backlinks to the page from other pages.

🚧 Excalidraw

Displaying Excalidraw sketches embedded in your notes.

🚧 CLI tool

Our goal is to make using Flowershow as seamless as possible. To facilitate smooth bootstrapping and upgrading your website we're creating a CLI tool, that will take care of all the intricacies related to the whole process of publishing your notes.

There is a lot of other exciting stuff we're working on. Check our roadmap to learn more!

Status

Alpha version, under very active construction 👷‍🏗🚧

Contributing

If you want to contribute, you are more than welcome! You can start by checking our project backlog.

If you have an idea for improvement, and it doesn't have a corresponding issue yet, simply submit a new one.

If you'd like to work on an existing issue:

1. Fork the main repository.
2. Clone the forked repository to your machine.
3. Create a feature branch (e.g. 50-update-readme, where 50 is the number of the related issue).
4. Commit your changes to the feature branch.
5. Push the feature branch to your forked repository.
6. Create a Pull Request against the original repository.
   • add a short description of the changes included in the PR
7. Address review comments if requested by the reviewers.