You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit bd9249d
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.html
+15-9Lines changed: 15 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,7 @@ <h2>🚀 Features</h2>
83
83
<li>🔒 Raw Markdown HTML is sanitized by default; use <code>--unsafe-html</code> to preserve it for trusted input</li>
84
84
<li>👀 <code>--watch</code> flag enables auto-rerender on file change (with debouncing)</li>
85
85
<li>🌐 <code>--open</code> flag renders to a temp dir and launches the system default browser</li>
86
-
<li>🧑🚀 <code>--setup</code> / no-arg interactive first-run guide, plus a Windows/Linux <code>mdo-setup</code> launcher that opens it for file-manager users</li>
86
+
<li>🧑🚀 Explicit <code>--setup</code> first-run guide, plus a Windows/Linux <code>mdo-setup</code> launcher that opens it for file-manager users</li>
87
87
<li>🧭 Built-in <code>--install-file-manager</code> / <code>--uninstall-file-manager</code> integration (no separate install scripts needed)</li>
88
88
<li>⚡ Fast and self-contained — no required runtime assets; <code>mdo.exe</code> remains the core CLI</li>
89
89
<li>🧩 Built on <code>pulldown-cmark</code>, <code>clap</code>, and <code>notify</code></li>
<p>The homepage source is <code>docs/index.md</code>; it uses only Markdown and the <code>--css docs/assets/site.css</code> override so the docs-only presentation is layered after
197
+
<p>The homepage source is <code>docs/index.md</code>; it uses only Markdown and the <code>--css docs/assets/site.css</code> override so the docs-only presentation is layered after
198
198
mdo's embedded simple.css and typography defaults. The sample preview source is
199
199
<code>docs/assets/sample.md</code>; <code>scripts/build-docs.py</code> renders it with
200
200
<code>docs/assets/sample.css</code> to demonstrate per-page CSS overrides. The GitHub Pages
@@ -243,10 +243,11 @@ <h3>First-run setup</h3>
243
243
<p>On Windows, double-click <code>mdo-setup.exe</code> to open that same guided setup in a
244
244
fresh Windows Terminal (<code>wt</code>) window, falling back to a plain new console if
245
245
<code>wt</code> is unavailable — the no-terminal entry point for Explorer users. On
246
-
Linux, run <code>mdo-setup</code> to get setup in your <code>$TERMINAL</code> or a known terminal emulator
247
-
(<code>gnome-terminal</code>, <code>konsole</code>, <code>xterm</code>, and others); it is also what <code>mdo-open</code>
248
-
runs when launched with no file. Double-clicking the bare <code>mdo-setup</code> binary from
249
-
a file manager is not reliable on Linux, so prefer <code>mdo --setup</code> from a shell.
246
+
Linux, launch <strong>mdo Setup</strong> from your application menu, or run <code>mdo-setup</code> to
247
+
open guided setup in your <code>$TERMINAL</code> or a known terminal emulator
248
+
(<code>gnome-terminal</code>, <code>konsole</code>, <code>xterm</code>, and others). It is also what <code>mdo-open</code>
249
+
runs when launched with no file. Running <code>mdo-setup</code> repairs its per-user
250
+
application-menu entry if needed.
250
251
This preserves <code>mdo</code> as the normal CLI. On Windows, launching <code>mdo-open.exe</code>
251
252
directly with no file opens the same guided setup in a fresh Windows Terminal
252
253
(<code>wt</code>) window using the <strong>One Half Light</strong> color scheme, centered on the active
show an action-oriented entry instead of a tool-name-only entry. Rerunning the
275
276
installer also removes older Nautilus Scripts entries named <strong>Preview with
276
277
mdo</strong> or <strong>Render with mdo</strong>.</p>
278
+
<p>The hosted Linux installer also writes the separate, visible
279
+
<code>~/.local/share/applications/mdo-setup.desktop</code> launcher. It has no MIME types
280
+
and remains installed if you run <code>mdo --uninstall-file-manager</code>; that command
281
+
only removes the hidden <strong>Open as HTML</strong> file-handler integration.</p>
277
282
<p>Linux release archives also include <code>mdo-setup</code>, which opens the same first-run
278
-
setup in a terminal window. It launches your <code>$TERMINAL</code> or a known terminal
279
-
emulator (<code>gnome-terminal</code>, <code>konsole</code>, <code>xterm</code>, and others); if none is found it
283
+
setup in a terminal window and registers itself as <strong>mdo Setup</strong> in Linux
284
+
application menus. It launches your <code>$TERMINAL</code> or a known terminal emulator
285
+
(<code>gnome-terminal</code>, <code>konsole</code>, <code>xterm</code>, and others); if none is found it
280
286
shows a <code>zenity</code>/<code>kdialog</code>/<code>yad</code> notice pointing you to <code>mdo --setup</code>. If you
281
287
launch <code>mdo-open</code> directly with no file, it opens <code>mdo-setup</code> when the setup
282
288
helper is present.</p>
@@ -413,6 +419,6 @@ <h2>📄 License</h2>
413
419
<p>at your option, matching the licensing of the upstream project.</p>
414
420
415
421
</main>
416
-
<footerclass="mdo-generated">Generated by <ahref="https://maphew.github.io/mdo/">mdo</a> 0.4.0 in 0.006s on <timedatetime="2026-06-18">2026-06-18</time>.</footer>
422
+
<footerclass="mdo-generated">Generated by <ahref="https://maphew.github.io/mdo/">mdo</a> 0.4.0 in 0.001s on <timedatetime="2026-07-10">2026-07-10</time>.</footer>
Copy file name to clipboardExpand all lines: docs/assets/sample.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -117,6 +117,6 @@ <h2>Commands</h2>
117
117
<p>Use <code>--bare</code> when another template owns the document shell.</p>
118
118
119
119
</main>
120
-
<footerclass="mdo-generated">Generated by <ahref="https://maphew.github.io/mdo/">mdo</a> 0.4.0 in 0.001s on <timedatetime="2026-06-18">2026-06-18</time>.</footer>
120
+
<footerclass="mdo-generated">Generated by <ahref="https://maphew.github.io/mdo/">mdo</a> 0.4.0 in 0.001s on <timedatetime="2026-07-10">2026-07-10</time>.</footer>
Copy file name to clipboardExpand all lines: docs/index.html
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1562,7 +1562,7 @@ <h3>Explore first</h3>
1562
1562
<p>Setup explains the render-and-open workflow, the normal convert-once command, and the reversible integration commands.</p>
1563
1563
<h3>Opt in when ready</h3>
1564
1564
<p>Running <code>mdo</code> with no arguments prints a short <strong>Open Markdown as HTML</strong> landing page and exits successfully; use <code>mdo --help</code> for the full CLI reference. Run <code>mdo --setup</code> when you want guided setup. On Windows and Linux it can offer to install <strong>Open as HTML</strong> for the current user only. The default answer is <strong>Yes</strong>, but mdo still does not change the default Markdown app. Choose <strong>No</strong> to skip or run setup again later.</p>
1565
-
<p>After you press Enter to finish setup, mdo opens a short welcome sample so you can immediately verify the browser-opening flow. On Windows, double-click <code>mdo-setup.exe</code> to open that same guided setup in a fresh Windows Terminal (<code>wt</code>) window, falling back to a plain new console if <code>wt</code> is unavailable. On Linux, run <code>mdo-setup</code> to open guided setup in your <code>$TERMINAL</code> or a known terminal emulator (<code>gnome-terminal</code>, <code>konsole</code>, <code>xterm</code>, and others); it is also what <code>mdo-open</code> runs when launched with no file. Double-clicking the bare binary from a file manager is not reliable on Linux, so prefer <code>mdo --setup</code> from a shell.</p>
1565
+
<p>After you press Enter to finish setup, mdo opens a short welcome sample so you can immediately verify the browser-opening flow. On Windows, double-click <code>mdo-setup.exe</code> to open that same guided setup in a fresh Windows Terminal (<code>wt</code>) window, falling back to a plain new console if <code>wt</code> is unavailable. On Linux, launch <strong>mdo Setup</strong> from your application menu or run <code>mdo-setup</code> to open guided setup in your <code>$TERMINAL</code> or a known terminal emulator (<code>gnome-terminal</code>, <code>konsole</code>, <code>xterm</code>, and others); it is also what <code>mdo-open</code> runs when launched with no file. Running it repairs its per-user application-menu entry if needed.</p>
1566
1566
<p>On Windows, launching <code>mdo-open.exe</code> directly with no file opens the same guided setup in a fresh Windows Terminal (<code>wt</code>) window using the <strong>One Half Light</strong> color scheme, centered on the active display; if <code>wt</code> is unavailable, it falls back to a plain new console.</p>
1567
1567
<h2>Usage</h2>
1568
1568
<p>By default, <code>mdo</code> writes a styled HTML file beside the source Markdown file. Use <code>--open</code> to render into a stable temp path and launch the default browser.</p>
@@ -1616,7 +1616,7 @@ <h3>Windows Explorer</h3>
1616
1616
<li><strong>Open with</strong> offers <strong>Open as HTML</strong>.</li>
1617
1617
<li>If <strong>Open as HTML</strong> is made the default handler, double-click opens the browser.</li>
1618
1618
<li>If <code>mdo-open.exe</code> is next to <code>mdo.exe</code>, it is used for flash-free Explorer launches; otherwise the single <code>mdo.exe</code> binary still works.</li>
1619
-
<li><code>mdo-setup.exe</code> and no-file <code>mdo-open.exe</code> open the guided setup in a fresh <code>wt</code> window with the <strong>One Half Light</strong> color scheme and center it on the active display, falling back to a plain new console when <code>wt</code> cannot be started.</li>
1619
+
<li><code>mdo-setup.exe</code> and no-file <code>mdo-open.exe</code> open guided setup in a fresh <code>wt</code> window with the <strong>One Half Light</strong> color scheme and center it on the active display, falling back to a plain new console when <code>wt</code> cannot be started.</li>
1620
1620
<li>Windows Open With should show the friendly name <strong>Open as HTML</strong> with the mdo icon instead of exposing the wrapper file name.</li>
<li>The hosted installer registers a visible <strong>mdo Setup</strong> application-menu entry at <code>~/.local/share/applications/mdo-setup.desktop</code>; running <code>mdo-setup</code> repairs it for Cargo or Homebrew installs. It is separate from the hidden <code>mdo.desktop</code> file handler and remains after <code>mdo --uninstall-file-manager</code>.</li>
1629
1630
<li><code>mdo-setup</code> opens the same first-run setup in a terminal window (your <code>$TERMINAL</code> or a known emulator such as <code>gnome-terminal</code>, <code>konsole</code>, or <code>xterm</code>); if none is found it shows a <code>zenity</code>/<code>kdialog</code>/<code>yad</code> notice pointing to <code>mdo --setup</code>.</li>
1630
1631
<li>Most XDG file managers show <strong>Open With -> Open as HTML</strong> for Markdown files.</li>
1631
1632
<li>GNOME Files/Nautilus uses the same Open With entry; no duplicate Scripts item is installed.</li>
@@ -1664,6 +1665,6 @@ <h2>Project Links</h2>
1664
1665
<p>mdo is dual-licensed under MIT or Apache-2.0 and forked with gratitude from Hafiz Ali Raza's original Markdown-to-HTML CLI.</p>
1665
1666
1666
1667
</main>
1667
-
<footerclass="mdo-generated">Generated by <ahref="https://maphew.github.io/mdo/">mdo</a> 0.4.0 in 0.004s on <timedatetime="2026-06-18">2026-06-18</time>.</footer>
1668
+
<footerclass="mdo-generated">Generated by <ahref="https://maphew.github.io/mdo/">mdo</a> 0.4.0 in 0.001s on <timedatetime="2026-07-10">2026-07-10</time>.</footer>
Copy file name to clipboardExpand all lines: docs/index.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -107,7 +107,7 @@ Setup explains the render-and-open workflow, the normal convert-once command, an
107
107
108
108
Running `mdo` with no arguments prints a short **Open Markdown as HTML** landing page and exits successfully; use `mdo --help` for the full CLI reference. Run `mdo --setup` when you want guided setup. On Windows and Linux it can offer to install **Open as HTML** for the current user only. The default answer is **Yes**, but mdo still does not change the default Markdown app. Choose **No** to skip or run setup again later.
109
109
110
-
After you press Enter to finish setup, mdo opens a short welcome sample so you can immediately verify the browser-opening flow. On Windows, double-click `mdo-setup.exe` to open that same guided setup in a fresh Windows Terminal (`wt`) window, falling back to a plain new console if `wt` is unavailable. On Linux, run `mdo-setup` to open guided setup in your `$TERMINAL` or a known terminal emulator (`gnome-terminal`, `konsole`, `xterm`, and others); it is also what `mdo-open` runs when launched with no file. Double-clicking the bare binary from a file manager is not reliable on Linux, so prefer `mdo --setup` from a shell.
110
+
After you press Enter to finish setup, mdo opens a short welcome sample so you can immediately verify the browser-opening flow. On Windows, double-click `mdo-setup.exe` to open that same guided setup in a fresh Windows Terminal (`wt`) window, falling back to a plain new console if `wt` is unavailable. On Linux, launch **mdo Setup** from your application menu or run `mdo-setup` to open guided setup in your `$TERMINAL` or a known terminal emulator (`gnome-terminal`, `konsole`, `xterm`, and others); it is also what `mdo-open` runs when launched with no file. Running it repairs its per-user application-menu entry if needed.
111
111
112
112
On Windows, launching `mdo-open.exe` directly with no file opens the same guided setup in a fresh Windows Terminal (`wt`) window using the **One Half Light** color scheme, centered on the active display; if `wt` is unavailable, it falls back to a plain new console.
- The hosted installer registers a visible **mdo Setup** application-menu entry at `~/.local/share/applications/mdo-setup.desktop`; running `mdo-setup` repairs it for Cargo or Homebrew installs. It is separate from the hidden `mdo.desktop` file handler and remains after `mdo --uninstall-file-manager`.
195
196
-`mdo-setup` opens the same first-run setup in a terminal window (your `$TERMINAL` or a known emulator such as `gnome-terminal`, `konsole`, or `xterm`); if none is found it shows a `zenity`/`kdialog`/`yad` notice pointing to `mdo --setup`.
196
197
- Most XDG file managers show **Open With -> Open as HTML** for Markdown files.
197
198
- GNOME Files/Nautilus uses the same Open With entry; no duplicate Scripts item is installed.
0 commit comments