Ever wanted to easily preview what your markdown would look like exactly on Github? Ever wanted to do that from inside of a Terminal?
Octodown uses the same parsers and CSS that Github uses for their markdown rendering. Github markdown styling looks beautiful, so it is Octodown's primary goal to reproduce it as faithfully as possible.
🆕 Edit your markdown like a boss with LiveReload.
octodown README.md
Uses the same markdown parsers and CSS as Github for true duplication.
Fast. octodown
uses native parsers to ensure performance.
Multiple CSS styles.
octodown --style atom README.md
github
markdown (default)atom
text editor markdownProperly parses STDIN
.
cat README.md | octodown --stdin
Requirements: Ruby >= 2.0
icu4c
and cmake
:brew install icu4c cmake pkg-config
sudo apt-get install -y libicu-dev cmake pkg-config ruby-dev
gem install octodown
sudo gem install octodown
Use asyncrun.vim:
" Plug 'skywind3000/asyncrun.vim' in your vimrc or init.nvim
:AsyncRun octodown %
" or, run whenever a mardown document is opened
autocmd FileType markdown :AsyncRun octodown %
Use Dispatch and add this to your ~/.vimrc:
" Use octodown as default build command for Markdown files
autocmd FileType markdown let b:dispatch = 'octodown %'
Caveat: make sure you follow the directions on the Dispatch README.md and make sure that the correct version of Ruby (the one which as Octodown install as a Gem), is used.
octodown
octodown --style atom README.md
echo '# Hello world!' | octodown --raw --stdin > index.html
--stdin
, octodown will read STDIN
until EOF
is reached.Ctrl-D
when finished.git checkout -b my-new-feature
)git commit -am 'Add some feature'
)bundle exec rake
)git push origin my-new-feature
)