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 bae5f03
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/index.md
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# mdo
2
2
3
-
**Markdown to HTML5**
3
+
**Open Markdown as HTML**
4
4
5
5
A fast lightweight command-line tool written in Rust that converts Markdown into HTML, with optional file-manager integration for immediate on-the-fly viewing. The CLI supports live watch mode to automatically re-render whenever the Markdown file is edited.
6
6
@@ -24,7 +24,7 @@ Binary: `mdo`
24
24
Package: `mdo-cli`
25
25
License: MIT or Apache-2.0
26
26
27
-

27
+

28
28
29
29
> sample.md rendered by mdo
30
30
>
@@ -50,13 +50,13 @@ License: MIT or Apache-2.0
50
50
51
51
## Why mdo?
52
52
53
-
Markdown is excellent for authoring and diffs, but long local Markdown files are calmer to read as browser-rendered HTML.
53
+
Markdown is excellent for authoring and diffs, but long files are more pleasant to read as browser-rendered HTML. Every day I read dozens to hundreds of Markdown files. Reading as rich text is smoother, calmer.
54
54
55
-
There are countless Markdown-to-HTML converters available, so why make another one and risk becoming another[xkcd:927](https://xkcd.com/927/) footnote?
55
+
Countless Markdown-to-HTML converters are available, so why make another one and risk becoming a[xkcd:927](https://xkcd.com/927/) footnote?
56
56
57
-
I could not find a simple, fast, and self-contained solution. Everything I looked at wanted to be a full-featured editor, relied on node or python in `PATH`, or needed another runtime dependency. Every day I read dozens to hundreds of Markdown files, and reading them as HTML is richer and calmer.
57
+
I couldn't find an existing simple, fast, and self-contained solution. Everything I discovered wanted to be a full-featured editor, relied on node or python in `PATH`, or needed another runtime dependency.
58
58
59
-
`mdo` plus file-manager integration creates disposable HTML pages quickly enough that opening Markdown can feel like opening a text file. That means fewer generated artifacts in source folders and fewer agent-workflow prompts that spend tokens asking for an HTML report.
59
+
`mdo` plus file-manager integration creates disposable HTML pages quickly enough that opening Markdown can feel like opening a text file. This means fewer generated artifacts in source folders and fewer agent-workflow prompts that spend tokens asking for an HTML report.
60
60
61
61
| Goal | What it means |
62
62
|---|---|
@@ -130,13 +130,15 @@ Setup explains the render-and-open workflow, the normal convert-once command, an
130
130
131
131
### Opt in when ready
132
132
133
-
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.
133
+
Running `mdo`withoit arguments prints a short **Open Markdown as HTML** landing page and exits successfully; use `mdo --help` for full CLI reference. Run `mdo --setup`for guided file manager integration. On Windows and Linux offers 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. After pressing Enter to finish setup, mdo opens a short welcome sample to verify the browser-opening flow.
134
134
135
-
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 without a terminal already open; on Linux, launch **mdo Setup** from your application menu or run `mdo-setup`. Launcher details are in the [file-manager integration guide](file-manager-integration.md).
135
+
On Windows, double-click `mdo-setup.exe` to open the same guided setup without a terminal; on Linux, launch **mdo Setup** from your application menu or run `mdo-setup`. Launcher details are in the [file-manager integration guide](file-manager-integration.md).
136
+
137
+
The two methods give same results.
136
138
137
139
## Usage
138
140
139
-
By default, `mdo` writes a styled HTML file beside the source Markdown file. Use `--open` to render into a stable temp path and launch the default browser.
141
+
By default, `mdo`cli in terminal writes a styled HTML file beside the source Markdown file. Use `--open` to render into a stable temp path and launch the default browser.
- Right-click a`.md` file and choose **Open as HTML**; on Windows 11 it may be under **Show more options**.
182
+
- Right-click an`.md` file and choose **Open as HTML**; on Windows 11 it may be under **Show more options**.
181
183
-**Open with** offers **Open as HTML**.
182
184
- If **Open as HTML** is made the default handler, double-click opens the browser.
183
185
- If `mdo-open.exe` is next to `mdo.exe`, it is used for flash-free Explorer launches; otherwise the single `mdo.exe` binary still works.
184
-
-`mdo-setup.exe` and no-file `mdo-open.exe` open guided setup in a fresh `wt`window with the **One Half Light** color scheme and center it on the active display, falling back to a plain new console when `wt` cannot be started.
186
+
-`mdo-setup.exe` and `mdo-open.exe` open guided setup in a fresh `wt`windows terminal with the **One Half Light** color scheme and center it on the active display, falling back to a plain new console when `wt` cannot be started.
185
187
- Windows Open With should show the friendly name **Open as HTML** with the mdo icon instead of exposing the wrapper file name.
186
188
187
189
### Linux File Managers
@@ -246,4 +248,4 @@ Release notes, architecture decisions, source code, and package metadata are all
246
248
247
249
---
248
250
249
-
mdo is dual-licensed under MIT or Apache-2.0 and forked with gratitude from Hafiz Ali Raza's original Markdown-to-HTML CLI.
251
+
mdo is dual-licensed under MIT or Apache-2.0, forked with gratitude from Hafiz Ali Raza's original Markdown-to-HTML CLI.
0 commit comments