matt-morris / flowershow

Publish your digital garden, docs or any markdown based site easily, quickly and elegantly

Home Page:https://flowershow.app/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

For full feature list see https://flowershow.app/#features

obsidian-vs-flowershow

Docs

https://flowershow.app/docs/

Forum

https://github.com/flowershow/flowershow/discussions

Chat

Come find us on Discord: https://discord.gg/cPxejPzpwt

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.

About

Publish your digital garden, docs or any markdown based site easily, quickly and elegantly

https://flowershow.app/

License:MIT License


Languages

Language:TypeScript 56.8%Language:JavaScript 31.5%Language:CSS 8.8%Language:Shell 2.8%