mdless

Less for CommonMark, a standardized variant of Markdown:

$ mdless sample.md

Installation and Requirements

Install Rust and run cargo install mdless.

To keep mdless up to date install cargo-update and run cargo install-update mdless.

mdless needs a decent modern terminal with a good font; in particular mdless uses

256 colours,
italic text, and
iTerm2 escape codes for marks.

iTerm2 works; I do not know about other terminal emulators.

Status and future plans

mdless supports all checked features in the list below. For unsupported syntax mdless panics!

Version 1

[x] Inline formatting, with proper nesting of emphasis
[x] Headings
[x] Block quotes
[x] Code blocks
[x] Ordered lists
[x] Numbered lists
[x] Nested lists
[x] Links
[x] Syntax highlighting for code blocks
[x] Show inline HTML and block HTML literally
[x] iTerm2 integration: Set marks for headings to jump back and forth
[ ] iTerm2 integration: Show images inline
[ ] Feed output to less for paging

Future plans

[ ] Automatically select highlight theme according to terminal background GH-5
[ ] Figure out a better way to show HTML GH-3
[ ] CommonMark extensions: Footnotes GH-1
[ ] CommonMark extensions: Tables GH-2
[ ] Ignore soft wraps and wrap inline text a column limit instead GH-4

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.