{"id":20221260,"url":"https://github.com/jannis-baum/vivify","last_synced_at":"2026-01-12T11:41:29.026Z","repository":{"id":186081409,"uuid":"668205431","full_name":"jannis-baum/Vivify","owner":"jannis-baum","description":"Live viewer for Markdown, HTML, Jupyter Notebooks \u0026 more","archived":false,"fork":false,"pushed_at":"2025-11-09T09:11:54.000Z","size":4641,"stargazers_count":106,"open_issues_count":16,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-11-09T11:20:54.129Z","etag":null,"topics":["jupyter-notebook-viewer","markdown-viewer","vim-markdown","vivify-viewer"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/jannis-baum.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-07-19T09:10:51.000Z","updated_at":"2025-11-07T04:02:15.000Z","dependencies_parsed_at":null,"dependency_job_id":"6f2478a2-f072-4788-b8af-8912ccbccad6","html_url":"https://github.com/jannis-baum/Vivify","commit_stats":null,"previous_names":["jannis-baum/vivify"],"tags_count":31,"template":false,"template_full_name":null,"purl":"pkg:github/jannis-baum/Vivify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannis-baum%2FVivify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannis-baum%2FVivify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannis-baum%2FVivify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannis-baum%2FVivify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jannis-baum","download_url":"https://codeload.github.com/jannis-baum/Vivify/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jannis-baum%2FVivify/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338972,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T10:58:46.209Z","status":"ssl_error","status_checked_at":"2026-01-12T10:58:42.742Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["jupyter-notebook-viewer","markdown-viewer","vim-markdown","vivify-viewer"],"created_at":"2024-11-14T06:52:40.132Z","updated_at":"2026-01-12T11:41:29.019Z","avatar_url":"https://github.com/jannis-baum.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Vivify\n\nVivify brings your files to life in the browser! Vivify is primarily made to\nrender Markdown and Jupyter Notebooks, but will also serve as a directory\nbrowser and let you view code files with syntax highlighting. See below for\nfeatures!\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/jannis-baum/assets/refs/heads/main/Vivify/showcase-dark.gif\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/jannis-baum/assets/refs/heads/main/Vivify/showcase-light.gif\"\u003e\n  \u003cimg alt=\"Showcase\" src=\"https://raw.githubusercontent.com/jannis-baum/assets/refs/heads/main/Vivify/showcase-dark.gif\"\u003e\n\u003c/picture\u003e\n\n\u003e [!TIP]\n\u003e We recently released [Jupyviv](https://github.com/jannis-baum/Jupyviv), a new\n\u003e solution for interacting with Jupyter Notebooks from plain text editors like\n\u003e Neovim by using Vivify as a live viewer. If you like Vivify and use Jupyter\n\u003e Notebooks, make sure to check out the project!\n\n## Features\n\n- view Markdown with various [features](#markdown-features)\n- view Jupyter Notebooks\n- view other plain text files with code syntax highlighting, or\n  [optionally](docs/customization.md) render HTML files\n- view image files\n- view \u0026 navigate directories using \"back to parent directory\" button at the\n  top-left of the file viewer\n- automatic reloads when files change\n- easy to integrate with any editor for fully live synchronization without\n  saving the file (see [editor support](#editor-support))\n- Vivify server starts lazily and automatically shuts down when no more viewers\n  are connected\n- various [customization options](docs/customization.md)\n- [produce nice looking PDFs](docs/pdfs.md) from Markdown\n- automatic parsing of front matter allowing for [custom\n  usage](docs/front-matter.md)\n  \nIf you need any additional features, feel free to [open an\nissue](https://github.com/jannis-baum/vivify/issues/new/choose) or\n[contribute](docs/CONTRIBUTING.md)!\n\n### Markdown features\n\n- full [basic](https://www.markdownguide.org/basic-syntax/) and\n  [extended](https://www.markdownguide.org/extended-syntax/) syntax support\n- [KaTeX math](https://katex.org)\n- [graphviz/dot graphs](https://graphviz.org/doc/info/lang.html)\n- [Mermaid diagrams \u0026 charts](https://mermaid.js.org)\n- alert blocks\n  - default styles like in [GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)\n  - [syntax extensions](docs/alerts.md#custom-marker) similar to [Obsidian\n    callouts](https://help.obsidian.md/callouts)\n  - configurable [custom alerts](docs/alerts.md#configuring-alert-icons)\n- links to other files: [relative links like in\n  GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#relative-links)\n  as well as absolute file links\n- [add styles, classes, ids or other attributes directly from\n  Markdown](https://github.com/arve0/markdown-it-attrs?tab=readme-ov-file#examples)\n- table of contents with `[[toc]]`\n- `\u003ckbd\u003e` tags, e.g. to style keyboard shortcuts\n\nYou can find examples for all supported features in the files in the\n[`tests/rendering`](tests/rendering) directory. In case you are looking at these\non GitHub, keep in mind that GitHub doesn't support some of the features that\nVivify supports so some things may look off.\n\n### Editor Support\n\nVivify has a simple API to integrate your favorite editor so the viewer live\nupdates to any changes as you are typing and the scrolling is smoothly\nsynchronized!\n\nSee below for a list of existing editor plugins. In case your favorite editor is\nnot yet supported, use these as an example to write your own and add it to the\nlist!\n\n#### Existing integration\n\n- for Vim and Neovim: [vivify.vim](https://github.com/jannis-baum/vivify.vim)\n- for micro: [micro-vivify](https://codeberg.org/gibbert/micro-vivify)\n\n## Installation\n\nOnce you have Vivify installed, use it by running `viv` with any text file or\ndirectory as an argument! See below for installation options.\n\n### Packaged\n\n\u003e [!NOTE]\n\u003e Missing a package for your system or package manager? Help us fill the gap by\n\u003e creating and contributing one – we're happy about PRs and will help with any\n\u003e questions you might have.\n\n- `brew install jannis-baum/tap/vivify` for [Homebrew](https://brew.sh)\n  (maintained by [@jannis-baum](https://github.com/jannis-baum))\n- `yay -S vivify` for [AUR](https://aur.archlinux.org/packages/vivify)\n  (maintained by [@tuurep](https://github.com/tuurep))\n- `nix-shell -p vivify`\n   for [Nixpkgs](https://search.nixos.org/packages?query=vivify)\n  (maintained by [@skohtv](https://github.com/skohtv))\n\n### Manual\n\n- download \u0026 unpack the [latest\n  release](https://github.com/jannis-baum/vivify/releases) for your system\n  (macOS or Linux)\n- add the two executables to your `$PATH`\n\n### Compile yourself\n\n- make sure you have [`yarn`](https://yarnpkg.com), `make` and `zip` installed\n- clone the repository\n- run `yarn`\n- run `./configure \u003cinstall_dir\u003e`\n- run `make install`\n\n\u003e [!TIP]  \n\u003e If you are having trouble building Vivify, or you'd like more detailed build\n\u003e instructions, see our [CONTRIBUTING](docs/CONTRIBUTING.md) page\n\n## Get help\n\nIs something not working or do you have any questions? [Start a\ndiscussion!](https://github.com/jannis-baum/vivify/discussions/new?category=q-a)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjannis-baum%2Fvivify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjannis-baum%2Fvivify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjannis-baum%2Fvivify/lists"}