KingDownloads

octodown

by ianks 691 stars MITProductivity

About octodown

Octodown is a command-line tool for previewing GitHub-flavored markdown files directly in the terminal. It replicates GitHub's markdown rendering by using the same parsers and CSS styles.

The tool supports live reloading, allowing users to edit markdown files and see changes in real time. It can process both file inputs and standard input streams, making it flexible for various workflows.

Key features

  • LiveReload for real-time markdown editing
  • Uses GitHub's markdown parsers and CSS for accurate rendering
  • Supports multiple CSS styles including GitHub and Atom themes
  • Processes STDIN input for pipeline integration
  • Fast performance with native parsers
  • Includes emoji support matching GitHub's implementation

Download v1.8.0

May 4, 2018

No direct download assets detected for the latest release.

View all 10 versions

Frequently asked questions

Is octodown free?
Yes. octodown is free and open-source software, distributed under the MIT license.
What is the latest version of octodown?
The latest version is v1.8.0, released on May 4, 2018.
What is Octodown?
Octodown is a command-line tool that previews GitHub-flavored markdown files using GitHub's rendering engine and styling.
How do I install Octodown?
Install required dependencies (icu4c, cmake, pkg-config), then install the gem via 'gem install octodown' or 'sudo gem install octodown' for system Ruby.
What platforms does Octodown support?
Octodown requires Ruby >= 2.0. Installation instructions are provided for Mac (Homebrew) and Linux (apt-get) systems.
Can I use Octodown with Vim?
Yes, Octodown can be integrated with Vim using plugins like asyncrun.vim or Dispatch for automatic previewing of markdown files.

More Productivity