{"id":13565033,"url":"https://github.com/vpj/annotate","last_synced_at":"2025-04-30T09:23:54.326Z","repository":{"id":41321723,"uuid":"204278037","full_name":"vpj/annotate","owner":"vpj","description":"Annotate python source code","archived":false,"fork":false,"pushed_at":"2020-04-09T11:07:41.000Z","size":739,"stargazers_count":69,"open_issues_count":2,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-30T14:51:12.186Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/vpj.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-08-25T10:17:52.000Z","updated_at":"2024-10-14T06:58:34.000Z","dependencies_parsed_at":"2022-09-11T09:02:07.772Z","dependency_job_id":null,"html_url":"https://github.com/vpj/annotate","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/vpj%2Fannotate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vpj%2Fannotate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vpj%2Fannotate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vpj%2Fannotate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vpj","download_url":"https://codeload.github.com/vpj/annotate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251675317,"owners_count":21625787,"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-08-01T13:01:39.480Z","updated_at":"2025-04-30T09:23:54.274Z","avatar_url":"https://github.com/vpj.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"/annotate.png?raw=true\" width=\"100%\" title=\"Logo\"\u003e\n\u003c/p\u003e\n\n## What is it?\n\nIt is a simple web app that lets you write Markdown side notes on your code,\nwithout making changes to the source files.\n\nThe idea is to write notes and comments outside the code so that code stays\n clean, short, and readable.\nNotes are matched based on similarity when the code changes.\nThe matching algorithm might need improvements.\n\nWe intend to use it for  personal note taking to understand code,\nwriting [tutorials](http://blog.varunajayasiri.com/ml/transformer.html),\nand for collaboration.\n\n### Clone and install\n\n```bash\ngit clone git@github.com:vpj/annotate.git\ncd annotate\ngit submodule init\ngit submodule update\n./install.sh\n```\n\nTo update run a git update\n\n```bash\ncd annotate\ngit pull\ngit submodule update\n./install.sh\n```\n\n### Starting the server\n\nNavigate to the path of the project and run the following command to start the server.\n\n```bash\nannotate\n```\n\n### Example\n\n[Annotation of Lab sample](http://blog.varunajayasiri.com/ml/lab3/#samples%2Fmnist_loop.py)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvpj%2Fannotate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvpj%2Fannotate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvpj%2Fannotate/lists"}