{"id":13533450,"url":"https://github.com/ianks/octodown","last_synced_at":"2025-05-15T14:05:12.241Z","repository":{"id":24620222,"uuid":"28029170","full_name":"ianks/octodown","owner":"ianks","description":"Github markdown previewing straight from your shell.","archived":false,"fork":false,"pushed_at":"2023-03-01T10:57:38.000Z","size":1811,"stargazers_count":693,"open_issues_count":8,"forks_count":32,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-11T05:06:04.026Z","etag":null,"topics":["github-flavored-markdown","github-markdown","markdown-editor","readme-md","ruby","vim"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ianks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-12-15T09:16:23.000Z","updated_at":"2025-01-02T05:03:12.000Z","dependencies_parsed_at":"2024-12-28T00:11:58.133Z","dependency_job_id":"c72a5bc2-b2fd-4471-ba27-ab2cccb7c992","html_url":"https://github.com/ianks/octodown","commit_stats":{"total_commits":214,"total_committers":15,"mean_commits":"14.266666666666667","dds":"0.19158878504672894","last_synced_commit":"3be56a34a3f79047360404e1c0f023720de8f81e"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianks%2Foctodown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianks%2Foctodown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianks%2Foctodown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ianks%2Foctodown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ianks","download_url":"https://codeload.github.com/ianks/octodown/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355334,"owners_count":22057354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-flavored-markdown","github-markdown","markdown-editor","readme-md","ruby","vim"],"created_at":"2024-08-01T07:01:19.948Z","updated_at":"2025-05-15T14:05:12.179Z","avatar_url":"https://github.com/ianks.png","language":"Ruby","funding_links":[],"categories":["Ruby","Awesome Ruby CLIs"],"sub_categories":["Workflow"],"readme":"# :octocat: octodown\n\n[![GemVersion](https://badge.fury.io/rb/octodown.svg)](http://badge.fury.io/rb/octodown)\n![Build Status](https://github.com/ianks/octodown/workflows/ci/badge.svg)\n\nEver wanted to easily preview what your markdown would look like _exactly_ on\nGithub? Ever wanted to do that from inside of a Terminal?\n\nOctodown uses the same parsers and CSS that Github uses for their markdown\nrendering. Github markdown styling looks beautiful, so it is Octodown's\nprimary goal to reproduce it as faithfully as possible.\n\n![Octodown GIF](assets/octodown.gif?raw=true)\n\n---\n\n## Features\n\n- :new: Edit your markdown like a boss with LiveReload.\n\n  - `octodown README.md`\n\n- Uses the same markdown parsers and CSS as Github for true duplication.\n\n  - Yes emojis _are_ included. :smiling_imp:\n\n- Fast. `octodown` uses native parsers to ensure performance.\n- Multiple CSS styles.\n\n  - `octodown --style atom README.md`\n  - The `github` markdown (default)\n  - The `atom` text editor markdown\n\n- Properly parses `STDIN`.\n  - `cat README.md | octodown --stdin`\n\n## Installation\n\n_Requirements_: Ruby \u003e= 2.0\n\n1. Install `icu4c` and `cmake`:\n\n- Mac: `brew install icu4c cmake pkg-config`\n- Apt: `sudo apt-get install -y libicu-dev cmake pkg-config ruby-dev`\n\n1. Install octodown:\n\n- If you have a non-system Ruby (_highly recommended_): `gem install octodown`\n- Else: `sudo gem install octodown`\n\n## Usage in VIM (_optional_):\n\n- Use [asyncrun.vim](https://github.com/skywind3000/asyncrun.vim):\n\n  ```viml\n  \" Plug 'skywind3000/asyncrun.vim' in your vimrc or init.nvim\n\n  :AsyncRun octodown %\n\n  \" or, run whenever a mardown document is opened\n\n  autocmd FileType markdown :AsyncRun octodown %\n  ```\n\n- Use [Dispatch](https://github.com/tpope/vim-dispatch) and add this to\n  your ~/.vimrc:\n\n  ```viml\n  \" Use octodown as default build command for Markdown files\n  autocmd FileType markdown let b:dispatch = 'octodown %'\n  ```\n\n- Caveat: make sure you follow the directions on the Dispatch README.md and\n  make sure that the correct version of Ruby (the one which as Octodown\n  install as a Gem), is used.\n\n## Usage\n\n1. Keeping it simple (choose your files from a menu):\n\n- `octodown`\n\n1. Markdown preview styling:\n\n- `octodown --style atom README.md`\n\n1. Unix lovers:\n\n- `echo '# Hello world!' | octodown --raw --stdin \u003e index.html`\n\n## Notes\n\n1. With `--stdin`, octodown will read `STDIN` until `EOF` is reached.\n\n- In order to work with this mode, type what you want into the input, then press\n  `Ctrl-D` when finished.\n\n## Contributing\n\n1. Fork it ( https://github.com/ianks/octodown/fork )\n1. Create your feature branch (`git checkout -b my-new-feature`)\n1. Commit your changes (`git commit -am 'Add some feature'`)\n1. Run the test suite (`bundle exec rake`)\n1. Push to the branch (`git push origin my-new-feature`)\n1. Create a new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fianks%2Foctodown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fianks%2Foctodown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fianks%2Foctodown/lists"}