diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml new file mode 100644 index 0000000..c67a3ff --- /dev/null +++ b/.github/workflows/pages.yml @@ -0,0 +1,46 @@ +name: Deploy site (GitHub Pages) + +# Publishes the product landing page in site/ to GitHub Pages (GTM §7 +# "真正的产品站"). Manual on purpose: going live changes the public homepage, +# which is the owner's call, and it also avoids a red run on main before Pages +# is enabled. +# +# ONE-TIME owner setup before the first run: +# 1. Repo → Settings → Pages → Build and deployment → Source: "GitHub Actions". +# 2. Run this workflow (Actions tab → "Deploy site" → Run workflow). +# 3. Point package.json `homepageUrl` / the repo "Website" at the Pages URL. +# After that, switching to auto-deploy is one line — add a `push:` trigger +# scoped to `paths: [site/**]`. + +on: + workflow_dispatch: {} + +permissions: + contents: read + pages: write + id-token: write + +# One concurrent deploy; don't cancel an in-progress publish. +concurrency: + group: pages + cancel-in-progress: false + +jobs: + deploy: + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - uses: actions/checkout@v6 + + - uses: actions/configure-pages@v5 + + - name: Upload site/ artifact + uses: actions/upload-pages-artifact@v3 + with: + path: site + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/site/README.md b/site/README.md new file mode 100644 index 0000000..c481e17 --- /dev/null +++ b/site/README.md @@ -0,0 +1,42 @@ +# site/ — Markup product landing page + +The product site for GTM-SCALE-PLAN.md §7 ("真正的产品站"): a single +self-contained `index.html` (inline CSS, no build step) plus `assets/`. + +Replaces the weak status quo where `homepageUrl` points at the releases page — +this is a real landing surface (hero, download matrix, feature grid, honest +comparison table, the GitHub-docs-reader wedge) tuned for conversion + SEO. + +## Honesty rules (keep these true) + +- **Platform truth:** macOS available; iOS/iPadOS "in review"; Windows/Linux + "coming soon" (CI-validated, not released). Update the day the beta ships. +- **Respectful comparison** (GTM §9): the table names where Typora/Obsidian are + stronger. Don't turn it into a hit piece. +- **No invented numbers / no fake social proof.** + +## Preview locally + +```bash +python3 -m http.server 8765 --directory site +# open http://localhost:8765 +``` + +## Publish (owner, one-time) + +GitHub Pages serves this via [`.github/workflows/pages.yml`](../.github/workflows/pages.yml): + +1. Repo → **Settings → Pages → Source: "GitHub Actions"**. +2. **Actions → "Deploy site" → Run workflow.** +3. Point `package.json` `homepageUrl` (and the repo "Website" field) at the + Pages URL. + +Going live is intentionally manual — publishing the public homepage is the +owner's call. After the first deploy, add a `push:` trigger scoped to +`paths: [site/**]` to auto-deploy on content changes. + +## Assets + +`hero.gif`, `screenshot-*.png`, `social-card.png`, `128x128@2x.png` are copied +from `docs/assets/` and `src-tauri/icons/`. If those originals change, refresh +the copies here. diff --git a/site/assets/128x128@2x.png b/site/assets/128x128@2x.png new file mode 100644 index 0000000..38aa354 Binary files /dev/null and b/site/assets/128x128@2x.png differ diff --git a/site/assets/hero.gif b/site/assets/hero.gif new file mode 100644 index 0000000..3f7f04c Binary files /dev/null and b/site/assets/hero.gif differ diff --git a/site/assets/screenshot-outline.png b/site/assets/screenshot-outline.png new file mode 100644 index 0000000..9cbc109 Binary files /dev/null and b/site/assets/screenshot-outline.png differ diff --git a/site/assets/screenshot-read.png b/site/assets/screenshot-read.png new file mode 100644 index 0000000..4a1243a Binary files /dev/null and b/site/assets/screenshot-read.png differ diff --git a/site/assets/screenshot-vault.png b/site/assets/screenshot-vault.png new file mode 100644 index 0000000..0f57388 Binary files /dev/null and b/site/assets/screenshot-vault.png differ diff --git a/site/assets/social-card.png b/site/assets/social-card.png new file mode 100644 index 0000000..cc95770 Binary files /dev/null and b/site/assets/social-card.png differ diff --git a/site/index.html b/site/index.html new file mode 100644 index 0000000..ea1e042 --- /dev/null +++ b/site/index.html @@ -0,0 +1,311 @@ + + + + + +Markup — a fast, native, open-source Markdown editor + + + + + + + + + + + + + + + +
+
+ Markup Markup + +
+
+ + +
+
+

Read your notes — and any GitHub repo —
like a beautiful web page.

+

Markup is a fast, native, open-source Markdown editor. Reader-first by design: it renders your Markdown like a polished page, and edits on demand.

+
+ Download for macOS + Star on GitHub ★ +
+

Free · Open source (MIT) · No account, no telemetry

+
+ Markup rendering Markdown like a web page, with a vault, backlinks, and search +
+
+
+ +
+
+
+

A reader-first Markdown app with a real knowledge base

+

Point it at a folder of notes — or a GitHub repo — and everything just works. Your files stay plain Markdown on disk.

+
+
+
📖

Reader-first

Renders Markdown like a web page — code, math, Mermaid, tables, callouts — and drops into editing when you want.

+
🗂️

Vault, links & graph

Open any folder as a vault: wikilinks, backlinks with context, a per-note outline, tags, and a graph view.

+
🔎

Instant full-text search

Tantivy-powered search across thousands of files in about a second, with tag: and path: filters.

+
🐙

Open a GitHub repo as a vault

Read a whole project's docs offline — and round-trip your edits back to GitHub.

+
🎨

Canvas & export

Obsidian-compatible Canvas, plus high-fidelity self-contained HTML and PDF export.

+
🔒

Private & native

Built on Tauri + Rust — small, fast, native. No account, no telemetry, no tracking.

+
+
+
+ +
+
+
+
Reading a rendered Markdown document in Markup
Read like a page — beautifully rendered
+
Browsing a vault of notes in Markup
A whole vault, not one file
+
Per-document outline and navigation in Markup
Outline, links & navigation
+
+
+
+ +
+
+
+

Download Markup

+

macOS is available now. iOS & iPadOS are in App Store review; Windows & Linux are on the way.

+
+
+
+ Available +

macOS

+

Apple Silicon & Intel · signed & notarized · auto-updates.

+ Download .dmg +
+
+ In review +

iPhone & iPad

+

Read-first vault on iOS & iPadOS with iCloud / Files.

+ App Store — soon +
+
+ Coming soon +

Windows & Linux

+

Builds are validated in CI (deb / AppImage / NSIS). Beta on the way.

+ Watch the repo +
+
+
+
+ +
+
+
+

How Markup compares

+

An honest look. Where another app is stronger for your workflow, we say so.

+
+
+ + + + + + + + + + + + + + + +
 MarkupTyporaObsidian
PriceFreePaidFree (personal)
Open sourceYes (MIT)NoNo
Native (not Electron)Yes (Tauri/Rust)YesNo
Reader-first renderingYesEditor-firstEditor-first
Vault · backlinks · graphYesNoYes
Open a GitHub repo as a vaultYes (round-trip)NoVia plugins
Plugin ecosystemYoungLimitedLarge & mature
TelemetryNone—Minimal
PlatformsmacOS, iOS (Win/Linux soon)mac/win/linuxAll
+
+

Typora is mature and cross-platform today; Obsidian has a deep plugin ecosystem. Markup focuses on a fast, native, open, reader-first core — and your files stay plain Markdown, so trying it costs you nothing.

+
+
+ +
+
+
+
+

Read any GitHub repo's docs — offline

+

Reading a project's README, /docs, or wiki on github.com is fine at a desk and miserable on the move. Markup opens any repo as a vault and renders the whole thing natively, online or off.

+
    +
  • Browse a repo's docs as one connected document set
    • +
  • Full-text search across the whole project
    • +
  • Fix a typo and round-trip it back to GitHub
    • +
  • On your Mac today — and your phone
    • +
+ Learn more on GitHub +
+ Reading a GitHub repository's documentation in Markup +
+
+
+ +
+
+
+

Bring your Markdown to life

+

Free, open source, native, and private by default.

+
+
+ Download for macOS + Star on GitHub ★ +
+
+
+ + + + +