{"id":15020924,"url":"https://github.com/datsfilipe/md-previewer","last_synced_at":"2025-10-26T17:31:01.350Z","repository":{"id":251098219,"uuid":"835012734","full_name":"datsfilipe/md-previewer","owner":"datsfilipe","description":"This helps you preview markdown files in the web with reloading support while watching for changes.","archived":true,"fork":false,"pushed_at":"2024-08-06T02:54:32.000Z","size":1780,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-21T11:48:34.781Z","etag":null,"topics":["markdown","markdown-preview","markdown-previewer","neovim","neovim-plugin","preview","previewer","vim"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/datsfilipe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-07-29T01:21:31.000Z","updated_at":"2025-01-23T01:39:23.000Z","dependencies_parsed_at":"2024-09-23T10:02:59.577Z","dependency_job_id":"47113f46-fc00-4929-afd8-31c9672e5972","html_url":"https://github.com/datsfilipe/md-previewer","commit_stats":{"total_commits":39,"total_committers":1,"mean_commits":39.0,"dds":0.0,"last_synced_commit":"975ae52b494c8b42565276a2c84e8e81132c9986"},"previous_names":["datsfilipe/md-previewer"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/datsfilipe/md-previewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsfilipe%2Fmd-previewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsfilipe%2Fmd-previewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsfilipe%2Fmd-previewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsfilipe%2Fmd-previewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/datsfilipe","download_url":"https://codeload.github.com/datsfilipe/md-previewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/datsfilipe%2Fmd-previewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281140931,"owners_count":26450543,"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","status":"online","status_checked_at":"2025-10-26T02:00:06.575Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["markdown","markdown-preview","markdown-previewer","neovim","neovim-plugin","preview","previewer","vim"],"created_at":"2024-09-24T19:55:51.668Z","updated_at":"2025-10-26T17:31:00.989Z","avatar_url":"https://github.com/datsfilipe.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Markdown Previewer\n\nThis binary helps you preview markdown files in the web with reloading support while watching for changes.\n\n## Demo\n\n![demo](./assets/preview.gif)\n\n## Usage\n\n```sh\nmd-previewer --file=path/to/file.md\n```\n\n## Neovim Plugin\n\n- Installation:\n\n```lua\n-- lazy.nvim\n{\n  'datsfilipe/md-previewer',\n  cmd = 'MdPreviewer',\n  ft = 'markdown',\n  -- this is for downloading the binaries from the latest release\n  build = \":lua dofile(vim.fn.stdpath('data') .. '/lazy/md-previewer/lua/build.lua')\",\n  opts = {\n    quiet = true, -- default is false but rn it has no real usage :0\n  },\n}\n\n-- packer.nvim\nuse {\n  'datsfilipe/md-previewer',\n  cmd = 'MdPreviewer',\n  ft = 'markdown',\n  -- this is for compiling the binaries with bun\n  run = 'bun install \u0026\u0026 bun compile',\n  config = function()\n    require('md-previewer').setup({\n      quiet = true, -- default is false but rn it has no real usage :0\n    })\n  end,\n}\n```\n\n### Troubleshooting\n\n- If you're not using `bun` to compile the binaries, you might need to set them as executables. For example, on Linux you can do `chmod +x /path/to/lazy/md-previewer/bin/*`. On other platforms you might want to search and see how it works.\n\n## Development\n\nIt's as any bun project, just run `bun run dev --file=path/to/file.md` to preview a file. `bun compile` will generate the binaries.\n\n- Neovim Plugin:\n\nI'm using [direnv](https://direnv.net/) to manage some env vars for Neovim to load the plugin right away instead of the `init.lua` in your `~/.config/nvim` folder. You might want to look into it. To use direnv for this simple do `mv .envrc1 .envrc` and `direnv allow`.\n\n- Any other enhancements are welcome :0\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatsfilipe%2Fmd-previewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdatsfilipe%2Fmd-previewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdatsfilipe%2Fmd-previewer/lists"}