Skip to content

Commit 9dc63f6

Browse files
chaxuschaxus
committed
feat: update footer links to include new document editor options and embed API
1 parent ff623ee commit 9dc63f6

20 files changed

Lines changed: 157 additions & 114 deletions

‎public/convert/csv-to-xlsx.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,11 @@ <h3>Does the converter work offline?</h3>
287287

288288
<footer>
289289
<a href="/">Open editor</a>
290-
<a href="/convert/xlsx-to-csv">XLSX to CSV</a>
290+
<a href="/open/docx">Open DOCX</a>
291291
<a href="/open/xlsx">Open XLSX</a>
292+
<a href="/open/pptx">Open PPTX</a>
293+
<a href="/private-document-editor">Private editor</a>
294+
<a href="/embed-document-editor">Embed API</a>
292295
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
293296
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
294297
</footer>

‎public/convert/xlsx-to-csv.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,8 +282,11 @@ <h3>Does the converter work offline?</h3>
282282

283283
<footer>
284284
<a href="/">Open editor</a>
285-
<a href="/convert/csv-to-xlsx">CSV to XLSX</a>
285+
<a href="/open/docx">Open DOCX</a>
286286
<a href="/open/xlsx">Open XLSX</a>
287+
<a href="/open/pptx">Open PPTX</a>
288+
<a href="/private-document-editor">Private editor</a>
289+
<a href="/embed-document-editor">Embed API</a>
287290
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
288291
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
289292
</footer>

‎public/edit-documents-without-account.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,10 @@ <h3>Can I use it offline without signing in?</h3>
252252
<footer>
253253
<a href="/">Open editor</a>
254254
<a href="/open/docx">Open DOCX</a>
255-
<a href="/no-signup-document-editor">No sign up</a>
256-
<a href="/offline-document-editor">Offline editor</a>
255+
<a href="/open/xlsx">Open XLSX</a>
256+
<a href="/open/pptx">Open PPTX</a>
257+
<a href="/private-document-editor">Private editor</a>
258+
<a href="/embed-document-editor">Embed API</a>
257259
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
258260
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
259261
</footer>

‎public/embed-document-editor.html‎

Lines changed: 44 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,12 @@
127127
"@type": "BreadcrumbList",
128128
"itemListElement": [
129129
{ "@type": "ListItem", "position": 1, "name": "Home", "item": "https://edit.chaxus.com/" },
130-
{ "@type": "ListItem", "position": 2, "name": "Embed Document Editor", "item": "https://edit.chaxus.com/embed-document-editor" }
130+
{
131+
"@type": "ListItem",
132+
"position": 2,
133+
"name": "Embed Document Editor",
134+
"item": "https://edit.chaxus.com/embed-document-editor"
135+
}
131136
]
132137
}
133138
]
@@ -194,8 +199,8 @@
194199
<h1>Embed a Document Editor in Your Web App</h1>
195200
<p class="lead">
196201
Add a <strong>DOCX, XLSX, PPTX and CSV</strong> editor to your product with a single iframe and a
197-
<strong>postMessage</strong> API. Your app keeps auth, file access and upload — the editor just edits, and
198-
never sees your users' tokens.
202+
<strong>postMessage</strong> API. Your app keeps auth, file access and upload — the editor just edits, and never
203+
sees your users' tokens.
199204
</p>
200205

201206
<a class="cta" href="/embed-demo.html"><r-button type="contrast">Open the live demo →</r-button></a>
@@ -231,7 +236,9 @@ <h2>What you get</h2>
231236
<ul>
232237
<li>One iframe + a small <strong>postMessage</strong> command/response API — no SDK to install</li>
233238
<li>Open from a <strong>URL, a File, or an ArrayBuffer</strong> your app fetched with its own credentials</li>
234-
<li>Save back to <strong>XLSX, DOCX, PPTX or CSV</strong>, returned as a <code>File</code> for your app to upload</li>
239+
<li>
240+
Save back to <strong>XLSX, DOCX, PPTX or CSV</strong>, returned as a <code>File</code> for your app to upload
241+
</li>
235242
<li>Read-only mode, per-message origin locking (<code>embedOrigin</code>), and a state query</li>
236243
<li>No document server to run — editing is 100% client-side WebAssembly</li>
237244
<li>Open source (AGPL-3.0) and self-hostable — embed it under your own domain</li>
@@ -240,38 +247,61 @@ <h2>What you get</h2>
240247
<h2>How it works</h2>
241248
<ol>
242249
<li>Add the iframe pointing at the editor with <code>?embed=1</code>, sized to your layout.</li>
243-
<li>Wait for the <code>document:ready</code> event, then send <code>document:open-url</code>, <code>open-file</code> or <code>open-buffer</code>.</li>
250+
<li>
251+
Wait for the <code>document:ready</code> event, then send <code>document:open-url</code>,
252+
<code>open-file</code> or <code>open-buffer</code>.
253+
</li>
244254
<li>The user edits in place; the file never leaves the browser unless your app sends it somewhere.</li>
245-
<li>Send <code>document:save</code>; the editor returns the edited file via <code>document:saved</code>, which your app uploads with its own auth.</li>
255+
<li>
256+
Send <code>document:save</code>; the editor returns the edited file via <code>document:saved</code>, which
257+
your app uploads with its own auth.
258+
</li>
246259
</ol>
247260

248261
<r-card class="oss"
249262
><div class="card-body">
250263
<strong>Open source &amp; self-hostable.</strong> Under AGPL-3.0 — read the code, run your own copy, and see
251-
exactly how the boundary works: <a href="https://github.com/ranuts/document" rel="noopener">github.com/ranuts/document</a>.
252-
Full API reference:
264+
exactly how the boundary works:
265+
<a href="https://github.com/ranuts/document" rel="noopener">github.com/ranuts/document</a>. Full API
266+
reference:
253267
<a href="https://github.com/ranuts/document/blob/main/docs/embed-api.md" rel="noopener">docs/embed-api.md</a>.
254268
</div></r-card
255269
>
256270

257271
<h2 class="faq">Frequently asked questions</h2>
258272
<div class="faq">
259273
<h3>How do I embed the document editor?</h3>
260-
<p>Add one iframe pointing at the editor with <code>?embed=1</code>, then drive it with a postMessage API to open and save documents. A working demo is at <a href="/embed-demo.html">/embed-demo.html</a>.</p>
274+
<p>
275+
Add one iframe pointing at the editor with <code>?embed=1</code>, then drive it with a postMessage API to open
276+
and save documents. A working demo is at <a href="/embed-demo.html">/embed-demo.html</a>.
277+
</p>
261278
<h3>Does the editor see my users' auth tokens?</h3>
262-
<p>No. Auth, file fetching and upload stay in your app — your app fetches the file with its own credentials and passes the bytes to the editor, so tokens and cookies never enter the iframe.</p>
279+
<p>
280+
No. Auth, file fetching and upload stay in your app — your app fetches the file with its own credentials and
281+
passes the bytes to the editor, so tokens and cookies never enter the iframe.
282+
</p>
263283
<h3>Which file formats can the embedded editor handle?</h3>
264-
<p>DOCX, XLSX, PPTX and CSV, edited client-side with the OnlyOffice WebAssembly engine. The save command exports to XLSX, DOCX, PPTX or CSV.</p>
284+
<p>
285+
DOCX, XLSX, PPTX and CSV, edited client-side with the OnlyOffice WebAssembly engine. The save command exports
286+
to XLSX, DOCX, PPTX or CSV.
287+
</p>
265288
<h3>Can I self-host it or use it white-label?</h3>
266-
<p>Yes. It's open source under AGPL-3.0 and ships as static files, so you can host your own copy and embed it under your own domain.</p>
289+
<p>
290+
Yes. It's open source under AGPL-3.0 and ships as static files, so you can host your own copy and embed it
291+
under your own domain.
292+
</p>
267293
<h3>How do I restrict which site can talk to the editor?</h3>
268-
<p>Add <code>embedOrigin</code> to the iframe URL to lock messaging to a specific origin, and verify <code>event.origin</code> in your own message handler.</p>
294+
<p>
295+
Add <code>embedOrigin</code> to the iframe URL to lock messaging to a specific origin, and verify
296+
<code>event.origin</code> in your own message handler.
297+
</p>
269298
</div>
270299

271300
<footer>
272301
<a href="/">Open editor</a>
273-
<a href="/embed-demo.html">Live demo</a>
274302
<a href="/open/docx">Open DOCX</a>
303+
<a href="/open/xlsx">Open XLSX</a>
304+
<a href="/open/pptx">Open PPTX</a>
275305
<a href="/private-document-editor">Private editor</a>
276306
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
277307
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>

‎public/no-signup-document-editor.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,6 +293,11 @@ <h3>Can I use it on my phone?</h3>
293293

294294
<footer>
295295
<a href="/">Open editor</a>
296+
<a href="/open/docx">Open DOCX</a>
297+
<a href="/open/xlsx">Open XLSX</a>
298+
<a href="/open/pptx">Open PPTX</a>
299+
<a href="/private-document-editor">Private editor</a>
300+
<a href="/embed-document-editor">Embed API</a>
296301
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
297302
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
298303
</footer>

‎public/offline-document-editor.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,8 +283,11 @@ <h3>Where are my files saved when offline?</h3>
283283

284284
<footer>
285285
<a href="/">Open editor</a>
286-
<a href="/no-signup-document-editor">No sign up</a>
287286
<a href="/open/docx">Open DOCX</a>
287+
<a href="/open/xlsx">Open XLSX</a>
288+
<a href="/open/pptx">Open PPTX</a>
289+
<a href="/private-document-editor">Private editor</a>
290+
<a href="/embed-document-editor">Embed API</a>
288291
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
289292
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
290293
</footer>

‎public/open/docx.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,8 @@ <h3>Is there a file size limit?</h3>
280280
<a href="/">Open editor</a>
281281
<a href="/open/xlsx">Open XLSX</a>
282282
<a href="/open/pptx">Open PPTX</a>
283-
<a href="/no-signup-document-editor">No sign up</a>
283+
<a href="/private-document-editor">Private editor</a>
284+
<a href="/embed-document-editor">Embed API</a>
284285
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
285286
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
286287
</footer>

‎public/open/pptx.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,8 @@ <h3>Are images and fonts preserved?</h3>
287287
<a href="/">Open editor</a>
288288
<a href="/open/docx">Open DOCX</a>
289289
<a href="/open/xlsx">Open XLSX</a>
290-
<a href="/no-signup-document-editor">No sign up</a>
290+
<a href="/private-document-editor">Private editor</a>
291+
<a href="/embed-document-editor">Embed API</a>
291292
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
292293
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
293294
</footer>

‎public/open/xlsx.html‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,8 @@ <h3>Are workbooks with multiple sheets supported?</h3>
287287
<a href="/">Open editor</a>
288288
<a href="/open/docx">Open DOCX</a>
289289
<a href="/open/pptx">Open PPTX</a>
290-
<a href="/convert/xlsx-to-csv">XLSX to CSV</a>
290+
<a href="/private-document-editor">Private editor</a>
291+
<a href="/embed-document-editor">Embed API</a>
291292
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
292293
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
293294
</footer>

‎public/private-document-editor.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,8 +252,9 @@ <h3>Does it still work without an internet connection?</h3>
252252
<footer>
253253
<a href="/">Open editor</a>
254254
<a href="/open/docx">Open DOCX</a>
255-
<a href="/no-signup-document-editor">No sign up</a>
256-
<a href="/offline-document-editor">Offline editor</a>
255+
<a href="/open/xlsx">Open XLSX</a>
256+
<a href="/open/pptx">Open PPTX</a>
257+
<a href="/embed-document-editor">Embed API</a>
257258
<a href="https://github.com/ranuts/document" rel="noopener">GitHub</a>
258259
<r-theme-switch class="theme-switch" label="Theme"></r-theme-switch>
259260
</footer>

0 commit comments

Comments
 (0)