{"id":22316384,"url":"https://github.com/nxllpointer/tide","last_synced_at":"2025-07-29T11:32:10.914Z","repository":{"id":264494303,"uuid":"893479709","full_name":"Nxllpointer/tide","owner":"Nxllpointer","description":"The Batteries-Included Typst Notetaking IDE","archived":false,"fork":false,"pushed_at":"2025-05-10T12:36:24.000Z","size":86,"stargazers_count":52,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-10T13:40:27.183Z","etag":null,"topics":["neovim","notes","notetaking","rnote","typesetting","typst"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nxllpointer.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":"2024-11-24T14:59:11.000Z","updated_at":"2025-04-30T08:54:45.000Z","dependencies_parsed_at":"2025-01-10T21:30:13.533Z","dependency_job_id":"7a612bd9-8176-4aa4-a9bb-4ea64a8daea8","html_url":"https://github.com/Nxllpointer/tide","commit_stats":null,"previous_names":["nxllpointer/tide"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Nxllpointer/tide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nxllpointer%2Ftide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nxllpointer%2Ftide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nxllpointer%2Ftide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nxllpointer%2Ftide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nxllpointer","download_url":"https://codeload.github.com/Nxllpointer/tide/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nxllpointer%2Ftide/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267678448,"owners_count":24126333,"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-07-29T02:00:12.549Z","response_time":2574,"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":["neovim","notes","notetaking","rnote","typesetting","typst"],"created_at":"2024-12-03T23:06:15.137Z","updated_at":"2025-07-29T11:32:10.908Z","avatar_url":"https://github.com/Nxllpointer.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌊 Tide - Notetaking built on free software 🌊\nTired of using proprietary applications to take notes? \\\nCan't choose between text-based ⌨️ or handwritten 📝 notes? \\\nTide has got you covered! Don't compromise - do both!\n\n## Showcase\nhttps://github.com/user-attachments/assets/303d4074-4846-41b9-9cdd-e7ea871fa4ab\n\n## How does it work?\nTide is a [neovim](https://neovim.io/) configuration specifically crafted for notetaking,\nmaking use of the [typst](https://github.com/typst/typst) typesetting tool\nand [Rnote](https://github.com/flxzt/rnote) for handwritten notes.\nSeamless integration between both of these tools is achieved with a modified version\nof the typst compiler, which can render Rnote documents like regular images.\nLanguage integration and real-time previewing is provided by [tinymist](https://github.com/Myriad-Dreamin/tinymist).\n\n## Awesome, but how to get started?\n🛠️ Tide is built using Nix, ensuring it can run out-of-the-box on any Linux 🐧 machine without issues. \\\n🔥 A separate Firefox profile also needs to be set up to prevent the preview tabs from mixing with your regular tabs.\n\n1. Installing tide\n    1. Install Nix with the [nix-installer](https://github.com/DeterminateSystems/nix-installer) - it's just a single command\n    1. Run `nix profile install github:Nxllpointer/tide#tide` This might take a while\n1. Setting up Firefox\n    1. Open Firefox\n    1. Enter `about:profiles` into the address bar\n    1. Create a new profile with the name `tide-preview`\n    1. Select your old profile as the default profile\n1. Creating a tide project (Or use the [tide-example](https://github.com/Nxllpointer/tide-example))\n    1. Create a `tideproject.json` file in the root of your project directory\n    1. Set the desired and required options ([See the reference](#reference-for-tideprojectjson))\n  \n## Using tide\nAfter setting up your tide project run `tide` in your project root (The directory with the `tideproject.json`) \\\nA complete and up-to-date list of keybindings can be found in the [mappings.lua](tide-nvim/lua/tide/mappings.lua) file\n\n- Create a new note\n- Start the real-time preview\n- Insert rnote documents into the current note\n\n\n## Reference for tideproject.json\n```json\n{\n  \"typst_template_dir\": \"required\u003cstring\u003e\",\n  \"rnote_template_file\": \"required\u003cstring\u003e\",\n  \"resources_subdir\": \"optional\u003cstring | null\u003e\",\n}\n```\n\u003e All paths are relative to the tideproject.json file!\n\n`typst_template_dir`: Path of the directory to copy for new typst notes \\\n`rnote_template_file`: Path of the file to copy for new Rnote documents \\\n`resources_subdir`: Subdirectory in the note directory to put resources (like Rnote documents) in. Defaults to `resources`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnxllpointer%2Ftide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnxllpointer%2Ftide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnxllpointer%2Ftide/lists"}