diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ad4a458..783533f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1190,6 +1190,14 @@ jobs: - name: Verify the focused React preview recipe download and source hashes run: python tools/check_react_preview_recipe.py - run: python -m mkdocs build --strict + - name: Verify the invoice walkthrough and preserve playground edits + run: python tools/check_walkthrough_page.py --site site --out output/playground-walkthrough --browser chrome + - uses: actions/upload-artifact@v4 + if: always() + with: + name: playground-walkthrough-verification + path: output/playground-walkthrough/ + retention-days: 14 - name: Materialize the verified published-wheel CSS evidence run: python tools/prepare_css_corpus_site.py site - run: python tools/check_site.py site diff --git a/docs/assets/playground/playground.css b/docs/assets/playground/playground.css index d69d175..10ad092 100644 --- a/docs/assets/playground/playground.css +++ b/docs/assets/playground/playground.css @@ -3,7 +3,7 @@ .pg-intro{padding:.5rem 0 1rem}.md-typeset .pg-eyebrow{font-size:.62rem;letter-spacing:.16em;font-weight:700;text-transform:uppercase;margin:0 0 .5rem;color:var(--md-accent-fg-color)} .md-typeset .pg-intro h1{font-size:2.7rem;line-height:1.1;margin:0 0 .7rem;font-weight:700;letter-spacing:-.06em}.pg-intro>p:last-child{color:var(--md-default-fg-color);font-size:.85rem;margin:.5rem 0} .pg-toolbar{display:flex;align-items:center;justify-content:space-between;gap:.75rem;padding:.8rem;background:var(--pg-paper);border:1px solid var(--pg-line);border-bottom:0;flex-wrap:wrap} -.pg-picker{display:flex;gap:.6rem;align-items:center;min-width:0}.pg-picker label{font-size:.62rem;font-weight:700;text-transform:uppercase;letter-spacing:.06em}.pg-picker select{min-width:0;max-width:100%;background:#fff;color:var(--pg-ink);font:inherit;font-size:.72rem;border:1px solid var(--pg-line);border-radius:0;padding:.55rem 2rem .55rem .65rem;appearance:auto} +.pg-picker{display:flex;gap:.6rem;align-items:center;min-width:0}.pg-picker label{font-size:.62rem;font-weight:700;text-transform:uppercase;letter-spacing:.06em}.pg-picker select{min-width:0;max-width:100%;background:#fff;color:var(--pg-ink);font:inherit;font-size:.72rem;border:1px solid var(--pg-line);border-radius:0;padding:.55rem 2rem .55rem .65rem;appearance:auto;color-scheme:light} .pg-actions{display:flex;gap:.45rem;align-items:center;flex-wrap:wrap}.fb-playground button,.pg-actions a{cursor:pointer;font:inherit;font-size:.68rem;font-weight:650;padding:.52rem .75rem;border:1px solid var(--pg-line);color:var(--pg-ink);background:#fff;line-height:1.35;text-decoration:none;white-space:nowrap} .pg-export{display:flex;align-items:center;justify-content:flex-end;gap:.65rem;flex-wrap:wrap;padding:.6rem .8rem;background:var(--pg-paper);border:1px solid var(--pg-line);border-bottom:0}.pg-export .pg-picker select{padding-top:.4rem;padding-bottom:.4rem} .fb-playground button:hover,.pg-actions a:hover{border-color:var(--pg-ink);background:#e8eee9}.fb-playground .pg-primary{background:var(--pg-ink);color:#fff;border-color:var(--pg-ink)}.fb-playground .pg-primary:hover{background:#245746;color:#fff}.pg-primary span{margin-left:.7rem} diff --git a/docs/assets/walkthroughs/invoice-20261102/captions.vtt b/docs/assets/walkthroughs/invoice-20261102/captions.vtt new file mode 100644 index 0000000..2dd35fb --- /dev/null +++ b/docs/assets/walkthroughs/invoice-20261102/captions.vtt @@ -0,0 +1,33 @@ +WEBVTT + +00:00:00.000 --> 00:00:04.000 +Customize an invoice in Fullbleed's free +HTML and CSS playground. + +00:00:04.000 --> 00:00:07.760 +Open the playground. Choose Northstar +invoice. + +00:00:07.760 --> 00:00:14.480 +Change the recipient from Maple & Finch to +Willow & Finch. + +00:00:14.480 --> 00:00:22.200 +Add a CSS rule to change the invoice +heading color. + +00:00:22.200 --> 00:00:30.240 +Choose Render PDF to preview the new +recipient and heading color. + +00:00:30.240 --> 00:00:34.600 +Choose Download PDF to save the finished +invoice. + +00:00:34.600 --> 00:00:42.240 +Choose Node.js, then Download project to +keep the editable source. + +00:00:42.240 --> 00:00:50.240 +Extract the Node.js ZIP. Run npm ci +--ignore-scripts, then npm run render. diff --git a/docs/assets/walkthroughs/invoice-20261102/poster.png b/docs/assets/walkthroughs/invoice-20261102/poster.png new file mode 100644 index 0000000..1307515 Binary files /dev/null and b/docs/assets/walkthroughs/invoice-20261102/poster.png differ diff --git a/docs/assets/walkthroughs/invoice-20261102/walkthrough.mp4 b/docs/assets/walkthroughs/invoice-20261102/walkthrough.mp4 new file mode 100644 index 0000000..b8453cc Binary files /dev/null and b/docs/assets/walkthroughs/invoice-20261102/walkthrough.mp4 differ diff --git a/docs/guides/playground-walkthrough.md b/docs/guides/playground-walkthrough.md new file mode 100644 index 0000000..f4c8378 --- /dev/null +++ b/docs/guides/playground-walkthrough.md @@ -0,0 +1,53 @@ +--- +title: Customize an invoice in the playground +description: "Watch a short Fullbleed walkthrough: edit an invoice with HTML and CSS, download the PDF, and run the exported Node.js project locally." +--- + +# Customize an invoice in the playground + +Start with the Northstar invoice in the [free playground](../playground.md). +Change its recipient and heading color, download the PDF, then take the editable +project into your own workflow. No account is needed to try it. + + +
A silent walkthrough with on-screen instructions and optional English captions. Read the transcript or download the MP4.
+ +## Transcript + +The recording uses the fictional **Northstar invoice** example. + +1. Open the [playground](../playground.md) and wait for the first PDF preview. +2. In the **HTML** editor, change `Maple & Finch` to `Willow & Finch`. +3. Select **CSS** and add this rule at the end: + + ```css + .invoice h1 { color: #b14d2e; } + ``` + +4. Choose **Render PDF**. The preview now shows the new recipient and a terracotta + **INVOICE** heading. +5. Choose **Download PDF** to save the finished invoice. +6. Expand **Files and projects**, select **Node.js**, and choose **Download project**. + You can also choose Python when exporting your own project. + +## Continue locally + +Use **Node.js 22 or newer**. Extract the Node.js project ZIP and open a terminal in +the extracted folder. Run: + +```bash +npm ci --ignore-scripts +npm run render +``` + +The renderer writes `output/document.pdf` and `output/preview/page-1.png`. +Edit `input.html` or `style.css`, then run `npm run render` again. +The ZIP includes the fonts, licenses, dependency lockfile, and renderer. + +For application data and reusable templates, continue with the +[Node.js quickstart](../getting-started/node.md). For a Python export, follow the +commands in [Keep building](../playground.md#keep-building). diff --git a/docs/playground.md b/docs/playground.md index ca83ddb..679bdaf 100644 --- a/docs/playground.md +++ b/docs/playground.md @@ -8,13 +8,13 @@ search: boost: 2 --- - +A little code. A finished page.
Edit an example or open your own HTML, CSS, images, and fonts. Everything runs on your device.
+Edit an example or open your own files. Runs on your device. Watch a short walkthrough ↗