https://github.com/flowershow/flowershow

💐 Publish your obsidian digital garden or any markdown site easily and elegantly.
https://github.com/flowershow/flowershow

blogging cms digital-garden markdown mdx nextjs nextjs-template obsidian-md tailwind-css

Last synced: about 9 hours ago
JSON representation

💐 Publish your obsidian digital garden or any markdown site easily and elegantly.

• Host: GitHub
• URL: https://github.com/flowershow/flowershow
• Owner: datopian
• License: mit
• Created: 2022-05-29T12:48:26.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-20T22:42:00.000Z (11 months ago)
• Last Synced: 2024-10-29T15:17:43.160Z (7 months ago)
• Topics: blogging, cms, digital-garden, markdown, mdx, nextjs, nextjs-template, obsidian-md, tailwind-css
• Language: TypeScript
• Homepage: https://flowershow.app/
• Size: 5.98 MB
• Stars: 833
• Watchers: 10
• Forks: 100
• Open Issues: 135
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-github-stars - flowershow/flowershow - 💐 Create beautiful books, wikis, websites and PKMs from markdown. (TypeScript)

README

        
# 🌷 Flowershow template

> 💐 Publish beautiful books, wikis, websites and PKMs from markdown. For free, no coding needed.

Flowershow is  an open-source tool and cloud service to quickly and easily turn your markdown into an elegant website, wiki, docs etc.

- **Markdown ... extended**: supports all standard Markdown plus many extensions and is fully compatible with e.g. Obsidian out of the box with no need to modify the syntax or change the file layout. 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

## [👉 See Flowershow in action on Flowershow.app](https://flowershow.app/)

![image](https://github.com/user-attachments/assets/aa5a6948-dc0e-4925-8154-1a30a02947fa)

## Docs

https://flowershow.app/docs/

- [Overview](https://flowershow.app/#overview)

- [QuickStart](https://flowershow.app/docs/publish-howto)

- [Roadmap](https://flowershow.app/docs/roadmap)

## Use with Obsidian Flowershow plugin

You can use this template together with the [Flowershow Obsidian Plugin](https://github.com/datopian/obsidian-flowershow).

See the README in the plugin repo for information on how to set it up.

## Quick clone and deploy

With Vercel:

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/datopian/flowershow)

## Forum

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

## Contributing

If you want to contribute, you are more than welcome! You can start by checking our [project backlog](https://github.com/orgs/flowershow/projects/1).

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.