{"id":21130825,"url":"https://github.com/ngn13/note-server","last_synced_at":"2025-07-09T01:33:34.522Z","repository":{"id":209299297,"uuid":"662811094","full_name":"ngn13/note-server","owner":"ngn13","description":"A web server to host your markdown notes","archived":false,"fork":false,"pushed_at":"2025-03-10T05:21:15.000Z","size":1390,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-04T14:37:42.239Z","etag":null,"topics":["markdown-note-reader","markdown-notes","note-hosting","note-markdown","note-search","note-sharing","note-taking"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/ngn13.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2023-07-06T00:11:29.000Z","updated_at":"2025-02-25T23:55:15.000Z","dependencies_parsed_at":"2024-04-13T16:31:22.898Z","dependency_job_id":"5cd00962-297e-4ed4-930a-72e2526ea1e6","html_url":"https://github.com/ngn13/note-server","commit_stats":null,"previous_names":["ngn13/note-server"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ngn13/note-server","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngn13%2Fnote-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngn13%2Fnote-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngn13%2Fnote-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngn13%2Fnote-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ngn13","download_url":"https://codeload.github.com/ngn13/note-server/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngn13%2Fnote-server/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264375587,"owners_count":23598409,"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":["markdown-note-reader","markdown-notes","note-hosting","note-markdown","note-search","note-sharing","note-taking"],"created_at":"2024-11-20T05:39:42.206Z","updated_at":"2025-07-09T01:33:34.270Z","avatar_url":"https://github.com/ngn13.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"images/index.png\" width=\"400px\"\u003e\n  \u003cimg src=\"images/note.png\" width=\"400px\"\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eNote Server 📝 Host your markdown notes\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003e\n  Just a web server that you can use to host\n  your markdown notes - written in Go!\n\u003c/h3\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg alt=\"GitHub License\" src=\"https://img.shields.io/github/license/ngn13/note-server?style=for-the-badge\"\u003e\n    \u003cimg alt=\"GitHub actions\" src=\"https://img.shields.io/github/actions/workflow/status/ngn13/note-server/publish.yml?style=for-the-badge\"\u003e\n    \u003cimg alt=\"GitHub go.mod Go version\" src=\"https://img.shields.io/github/go-mod/go-version/ngn13/note-server?style=for-the-badge\"\u003e\n\u003c/p\u003e\n\n## ✨ Features\n- Minimal dark UI (with no javascript)\n- Content and path based searching \n- Modification time based sorting\n- Image and link support \n\n## 😋 Setup\n### with Docker \n```bash\n# bring in your notes, for example:\ngit clone https://github.com/your/cool-notes.git\nmv cool-notes notes\n\ndocker run -d -v $PWD/notes:/notes      \\\n              -p 80:8080                \\\n              --name my-notes           \\\n              ghcr.io/ngn13/note-server \n```\nNow you can connect to note server on port 80, you can extend this setup with a reverse proxy if you wish.\n\n### without Docker\nYou can build and install the application from the source using `make`:\n```bash\n# obtain the latest sources\ngit clone https://github.com/ngn13/note-server\ncd note-server\n\nmake\n```\n\nTo install the binary to your PATH, you can use run the installation command as root:\n```bash\nsudo make install\n```\n\nThen you can run the server with `note-server` command:\n```bash\nnote-server -notes /path/to/your/notes\n```\n\n## ⚙️ Options\nTo list available command-line options, use the `-help` flag:\n```\nUsage of note-server:\n  -interface string\n        Web server interface (host:port) (default \"127.0.0.1:8080\")\n  -notes string\n        Path for the directory that contains your notes\n  -static string\n        Static files directory path (default \"/usr/lib/note-server/static\")\n  -views string\n        HTML templates directory path (default \"/usr/lib/note-server/views\")\n```\n\n## 🔄 Auto-updating your notes \nIf you are using git for your notes, then you can setup a cronjob to auto-update your notes.\n\nTo do this add this enrty to your `/etc/crontab`:\n```\n  0  *  * * *   your-username     cd /path/to/your/notes \u0026\u0026 /usr/bin/git pull\n```\nThis entry will pull and sync your notes with the remote every hour.\n\n## 🔗 Credit\n- [github-markdown-css](https://github.com/sindresorhus/github-markdown-css): Used for markdown rendering\n- [nerdfonts](https://github.com/ryanoasis/nerd-fonts): Fonts used in the application \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngn13%2Fnote-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fngn13%2Fnote-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngn13%2Fnote-server/lists"}