KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #codex #ai-agents #claude-code #dsh #dsh-plugin #cli #macos #ai-agent #deepseek-harness #open-source

flowershow

★ 1,100 Open GitHub ↗

💐 Publish markdown (and html) websites, docs, wikis and websites in seconds. Integrates with your AI.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![skills.sh](https://skills.sh/b/flowershow/skills)](https://skills.sh/flowershow/skills)

# Flowershow 💐

> ## Publish markdown quickly and easily - for docs, knowledgebases, websites and more

### Try it out now and sign up at https://flowershow.app/

Want to see it in action? 🎉 https://flowershow.app itself is built and published with Flowershow 💐

- 📝 Docs: https://flowershow.app/docs
- 🤖 for AI: https://flowershow.app/cli
- 💎 for Obsidian: https://flowershow.app/uses/obsidian

Flowershow is proudly open-source.

Flowershow is a product of [Datopian](https://datopian.com) - dedicated to democratising the power of data & knowledge.

---

# For Developers

The information below is for folks interesting in contributing to or using Flowershow from source.

## Monorepo Structure

This is a [Turborepo](https://turbo.build/) monorepo managed with [pnpm](https://pnpm.io/) workspaces.

```
apps/
  flowershow/           # Next.js web application (flowershow.app)
  cli/                  # Go CLI (`fl`) — publish markdown files from the terminal or AI agents
packages/
  api-contract/         # @flowershow/api-contract — Zod schemas, TS types, OpenAPI 3.1 spec
  cloudflare-worker/    # Markdown processing Cloudflare worker
  remark-wiki-link/     # @flowershow/remark-wiki-link — remark plugin for wiki-style links
content/
  flowershow-app/       # Marketing site content (Obsidian vault, not a workspace package)
```

## Quick Start

**Prerequisites:** [Node.js 22+](https://nodejs.org/), [pnpm](https://pnpm.io/installation), and [Docker](https://docs.docker.com/get-docker/).

```bash
# Clone (include the e2e test-site submodule)
git clone --recurse-submodules https://github.com/flowershow/flowershow.git
cd flowershow

# Install dependencies
pnpm install

# Copy env template (then edit apps/flowershow/.env with your secrets)
cp apps/flowershow/.env.example apps/flowershow/.env

# Start everything: Postgres, MinIO, Inngest, Cloudflare Worker, Next.js app
pnpm dev
```

Visit `http://cloud.localhost:3000` once it's running.

> If you already cloned without `--recurse-submodules`, run
> `git submodule update --init` to fetch the e2e test site.

### Commands

```bash
pnpm dev --stripe              # Also start Stripe webhook forwarding
pnpm dev --github              # Also start Smee (GitHub webhook proxy)
pnpm dev --search              # Also start Typesense
pnpm dev:all                   # Start everything including all optional services

pnpm dev:local                 # Start dev servers only (no Docker infrastructure)
pnpm dev:local:all             # Start dev servers only + all optional services
pnpm dev:down                  # Stop Docker containers (keep data)
pnpm dev:nuke                  # Stop containers + delete all data volumes

pnpm build                     # Build all packages
pnpm test                      # Run tests across all packages
pnpm lint                      # Lint all packages (ESLint for app, Biome for packages)
pnpm format                    # Check formatting (Biome)
pnpm format:write              # Auto-fix formatting
```

For web app setup (database, storage, auth, etc.), see [`apps/flowershow/README.md`](apps/flowershow/README.md).

## Tooling

| Tool                                                   | Scope                       | Purpose                                                                |
| ------------------------------------------------------ | --------------------------- | ---------------------------------------------------------------------- |
| [Biome](https://biomejs.dev/)                          | Entire repo                 | Formatting (single quotes, 2-space indent) and linting for `packages/` |
| [ESLint](https://eslint.org/)                          | `apps/flowershow`           | Next.js-specific linting via `eslint-config-next`                      |
| [Vitest](https://vitest.dev/)                          | `packages/remark-wiki-link` | Unit tests                                                             |
| [Playwright](https://playwright.dev/)                  | `apps/flowershow`           | E2E tests                                                              |
| [Turborepo](https://turbo.build/)                      | Root                        | Task orchestration and caching                                         |
| [Changesets](https://github.com/changesets/changesets) | `packages/`                 | Versioning and npm publishing                                          |
| [Husky](https://typicode.github.io/husky/)             | Root                        | Git hooks (pre-commit runs lint-staged)                                |

A pre-commit hook automatically formats staged files via lint-staged before each commit.

### Releasing packages

```bash
pnpm changeset                 # Create a changeset describing your change
pnpm version-packages          # Bump versions based on changesets
pnpm release                   # Build all packages and publish to npm
```

## Documentation

- **Web app**: [`apps/flowershow/README.md`](apps/flowershow/README.md) — architecture, local dev setup, environment config, testing, troubleshooting
- **REST API contract**: [`packages/api-contract/README.md`](packages/api-contract/README.md) — Zod schemas, TypeScript types, and OpenAPI 3.1 spec for the Flowershow REST API. The contract is the single source of truth for the API surface; the Next.js API routes, CLI, and Obsidian plugin all consume it.
- **Interactive API docs**: With the dev server running, visit `http://cloud.flowershow.local:3000/api/docs` for Swagger UI, or `/api/docs/openapi.json` for the raw spec. In production: [flowershow.app/api/docs](https://flowershow.app/api/docs).
- **CLI**: [`apps/cli/README.md`](apps/cli/README.md) — Go CLI for publishing markdown files. Also the interface for AI agent integration — see the [Flowershow skill](https://github.com/flowershow/skills).
- **User docs**: [flowershow.app/docs](https://flowershow.app/docs)

## Community

- Browse [existing issues](https://github.com/flowershow/flowershow/issues) or [submit a new one](https://github.com/flowershow/flowershow/issues/new)
- Visit our [discussions](https://github.com/flowershow/flowershow/discussions) to ask questions, share ideas, or showcase your Flowershow site

## Contributing

We're working on opening up parts of Flowershow for community contributions. While this isn't ready yet, we're excited to welcome contributors soon.

You can already contribute by adding pull requests for demos or tests of Flowershow markdown features:

- **Demo**: [demo.flowershow.me](https://demo.flowershow.me) — [github.com/flowershow/demo](https://github.com/flowershow/demo)
- **Test**: [test.flowershow.me](https://test.flowershow.me/) — [github.com/flowershow/test](https://github.com/flowershow/test)

### Development Workflow

1. Create feature branch from `staging`
2. Implement changes
3. Submit PR to `staging`
4. After approval, changes are merged to `main`

We use squash merges to `staging` with conventional commit messages.

flowershow

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README