{"id":27900414,"url":"https://github.com/fvd/zettelviewer","last_synced_at":"2025-07-07T12:08:00.814Z","repository":{"id":288843547,"uuid":"969319251","full_name":"FvD/zettelviewer","owner":"FvD","description":"Lightweight viewer of zettel notes in markdown as HTML files ","archived":false,"fork":false,"pushed_at":"2025-04-19T22:17:30.000Z","size":14,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-05T20:14:50.329Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/FvD.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-19T21:57:06.000Z","updated_at":"2025-04-21T15:24:37.000Z","dependencies_parsed_at":"2025-04-19T23:19:53.044Z","dependency_job_id":"b782fc47-6231-4254-b1d4-1ee1ef0928a4","html_url":"https://github.com/FvD/zettelviewer","commit_stats":null,"previous_names":["fvd/zettelviewer"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FvD%2Fzettelviewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FvD%2Fzettelviewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FvD%2Fzettelviewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FvD%2Fzettelviewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FvD","download_url":"https://codeload.github.com/FvD/zettelviewer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252569648,"owners_count":21769517,"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":"2025-05-05T20:14:52.941Z","updated_at":"2025-05-05T20:14:53.452Z","avatar_url":"https://github.com/FvD.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Zettelviewer\n\nA lightweight, memory-efficient Markdown viewer specifically designed for Zettelkasten note collections.\n\n## Overview\n\nZettelviewer is a simple web-based tool that renders Markdown files from a specified directory without writing any HTML files to disk. It's particularly useful for quickly browsing through Zettelkasten-style notes in a clean, formatted interface.\n\nKey features:\n- Renders Markdown files to HTML in memory (no files written to disk)\n- Displays file names alongside their titles (from H1 headings)\n- Clean, readable interface with proper formatting for code blocks\n- Built-in web server for easy viewing in any browser\n- Support for common Markdown extensions (tables, footnotes, strikethrough, task lists)\n\n## Installation\n\n### Prerequisites\n- Rust and Cargo (https://www.rust-lang.org/tools/install)\n\n### Building from source\n```bash\n# Clone the repository\ngit clone https://github.com/yourusername/zettelviewer.git\ncd zettelviewer\n\n# Build in release mode\ncargo build --release\n\n# The binary will be available at target/release/zettelviewer\n```\n\n## Usage\n\n```bash\n# Start the server with the path to your Markdown folder\n./zettelviewer path/to/your/markdown/folder\n```\n\nThen open `http://localhost:3030` in your web browser to view your notes.\n\n## Features\n\n### Supported Markdown Features\n- Headers (H1-H6)\n- Emphasis (bold, italic)\n- Lists (ordered and unordered)\n- Code blocks with syntax highlighting\n- Tables\n- Blockquotes\n- Links\n- Images\n- Footnotes\n- Strikethrough\n- Task lists\n\n### Zettelkasten Integration\nZettelviewer is designed with Zettelkasten note-taking methodology in mind:\n- File names are displayed together with their titles for easy reference\n- Clean interface allows for distraction-free reading\n- In-memory rendering respects the plain text philosophy of Zettelkasten\n\n## Customization\n\nYou can customize the HTML templates and styling by modifying the source code. Look for the HTML template strings in `src/main.rs`.\n\n## Development\n\n### Dependencies\n- `pulldown-cmark`: For Markdown parsing\n- `warp`: For the web server\n- `tokio`: For async runtime\n\n### Building for development\n```bash\ncargo build\ncargo run -- path/to/your/markdown/folder\n```\n\n### Project Structure\n- `src/main.rs`: Contains all the code for the application\n\n## Contributing\n\nContributions are welcome! Feel free to submit issues or pull requests.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Acknowledgments\n\n- Built using Rust and several awesome crates\n- Inspired by the Zettelkasten method of note-taking\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvd%2Fzettelviewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffvd%2Fzettelviewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvd%2Fzettelviewer/lists"}