{"id":18508857,"url":"https://github.com/flaport/smdv","last_synced_at":"2025-04-09T20:51:03.383Z","repository":{"id":57468683,"uuid":"194604549","full_name":"flaport/smdv","owner":"flaport","description":"a simple markdown viewer","archived":false,"fork":false,"pushed_at":"2020-08-22T13:46:22.000Z","size":116,"stargazers_count":9,"open_issues_count":3,"forks_count":6,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-23T22:42:25.745Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flaport.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-01T05:20:17.000Z","updated_at":"2022-11-17T22:00:40.000Z","dependencies_parsed_at":"2022-09-19T09:51:48.960Z","dependency_job_id":null,"html_url":"https://github.com/flaport/smdv","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flaport%2Fsmdv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flaport%2Fsmdv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flaport%2Fsmdv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flaport%2Fsmdv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flaport","download_url":"https://codeload.github.com/flaport/smdv/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247999866,"owners_count":21031046,"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":[],"created_at":"2024-11-06T15:15:38.708Z","updated_at":"2025-04-09T20:51:03.363Z","avatar_url":"https://github.com/flaport.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# smdv\n\na **s**imple **m**ark**d**own **v**iewer for linux.\n\n## Dependencies\n\n### Required\n\n- `python3` pointing to Python 3.6+.\n- [Pandoc](http://pandoc.org/) 2.0+ [`apt install pandoc` | `pacman -S pandoc` | ... ]\n- [Flask](http://flask.pocoo.org/) [`pip3 install flask` | `apt install python3-flask` | `pacman -S python-flask` | ... ]\n- [Websockets](https://websockets.readthedocs.io/) [`pip3 install websockets` | `apt install python3-websockets` | `pacman -S python-websockets` | ... ]\n\n### Optional\n\n- [Jupyter](http://jupyter.org) (to view jupyter notebooks) [`pip3 install jupyter` | `apt install jupyter` | `pacman -S jupyter` | ... ]\n- [Neovim Remote](https://github.com/mhinz/neovim-remote) [`pip3 install neovim neovim-remote`]\n\n## Installation\n\n```\n    pip3 install smdv\n```\n\n## Configuration\n\nsmdv listens to a single environment variable: `SMDV_DEFAULT_ARGS`. As an example, below\nyou can see how smdv can be configured to always open in firefox on port 9999 by placing\nthe following line in your `.bashrc`:\n\n```\nSMDV_DEFAULT_ARGS=\"--browser firefox --port 9999\"\n```\n\nConsult `smdv --help` to see which flags can be used.\n\n## Compatibility with neovim\n\nThis viewer was made with neovim compatibility in mind. With the use of `neovim-remote`,\nthis script is able to open files in the current neovim window (or spawn a new neovim\nwindow if there is no window available).\n\nHowever, to make it fully compatible with neovim and to make neovim able to sync\nits current file to the viewer, [neovim-remote](https://github.com/mhinz/neovim-remote)\nshould be installed and the following line should be added to your `init.vim`:\n\n```\n    \" sync on save\n    autocmd BufWritePost *.md silent execute '!smdv 'expand('%:p')' -v \"'.v:servername'\"'\n```\n\nThis setting will sync the file to the viewer after every save.\n\n## Compatibility with vim-instant-markdown\n\nAlternatively, if syncing after every save is not enough, smdv can also be used\nin conjuction with\n[vim-instant-markdown](https://github.com/suan/vim-instant-markdown) for\ninstant markdown previews. Install the vim-plugin and add the following line to\nyour vimrc:\n\n```\nlet g:instant_markdown_python = 1\n```\n\nThis line disables the default javascript daemon handling instant previews in favor of\nsmdv. Consider removing the _sync-on-save_ line defined above when using this\noption; both options are not completely compatible.\n\n## Screenshots\n\n### markdown preview\n\n![smdv-dir](img/smdv-md.png)\n\n### folder view\n\n![smdv-dir](img/smdv-dir.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaport%2Fsmdv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflaport%2Fsmdv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaport%2Fsmdv/lists"}