{"id":13471377,"url":"https://github.com/silverbulletmd/silverbullet","last_synced_at":"2026-05-20T19:11:07.144Z","repository":{"id":41098347,"uuid":"459944886","full_name":"silverbulletmd/silverbullet","owner":"silverbulletmd","description":"An open source personal productivity platform built on Markdown, turbo charged with the scripting power of Lua","archived":false,"fork":false,"pushed_at":"2025-05-07T17:14:38.000Z","size":34929,"stargazers_count":3291,"open_issues_count":305,"forks_count":244,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-05-07T17:45:47.106Z","etag":null,"topics":["end-user-programming","knowledge-management","lua","markdown","note-taking","personal-knowledge-management"],"latest_commit_sha":null,"homepage":"https://silverbullet.md","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/silverbulletmd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","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},"funding":{"github":"silverbulletmd"}},"created_at":"2022-02-16T09:56:34.000Z","updated_at":"2025-05-07T17:14:42.000Z","dependencies_parsed_at":"2023-11-11T13:39:09.764Z","dependency_job_id":"d19b2fff-ed6f-4e11-a487-b6c098b5d412","html_url":"https://github.com/silverbulletmd/silverbullet","commit_stats":{"total_commits":704,"total_committers":25,"mean_commits":28.16,"dds":"0.10653409090909094","last_synced_commit":"eb731244816571acd5908d44eb67e6baf3b13938"},"previous_names":[],"tags_count":86,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silverbulletmd%2Fsilverbullet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silverbulletmd","download_url":"https://codeload.github.com/silverbulletmd/silverbullet/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254029008,"owners_count":22002284,"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":["end-user-programming","knowledge-management","lua","markdown","note-taking","personal-knowledge-management"],"created_at":"2024-07-31T16:00:43.922Z","updated_at":"2026-05-20T19:11:07.138Z","avatar_url":"https://github.com/silverbulletmd.png","language":"TypeScript","funding_links":["https://github.com/sponsors/silverbulletmd"],"categories":["TypeScript","lua","note-taking","markdown","Open Source","Table of Contents"],"sub_categories":["Web UI","Note Taking"],"readme":"![GitHub Repo stars](https://img.shields.io/github/stars/silverbulletmd/silverbullet)\n![Docker Pulls](https://img.shields.io/docker/pulls/zefhemel/silverbullet)\n![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/silverbulletmd/silverbullet/total)\n![GitHub contributors](https://img.shields.io/github/contributors/silverbulletmd/silverbullet)\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/silverbulletmd/silverbullet)\n\n# SilverBullet\nSilverBullet is a Programmable, Private, Browser-based, Open Source, Self Hosted, Personal Knowledge Management Platform.\n\n_Yowza!_ That surely is a lot of adjectives to describe a browser-based Markdown editor programmable with Lua.\n\nLet’s get more specific.\n\nIn SilverBullet you keep your content as a collection of Markdown Pages (called a Space). You navigate your space using the Page Picker like a traditional notes app, or through Links like a wiki (except they are bi-directional).\n\nIf you are the **writer** type, you’ll appreciate SilverBullet as a clean Markdown editor with Live Preview. If you have more of an **outliner** personality, SilverBullet has Outlining tools for you. Productivity freak? Have a look at Tasks. More of a **database** person? You will appreciate Objects and Queries. \n\nAnd if you are comfortable **programming** a little bit — now we’re really talking. You will love _dynamically generating content_ with Space Lua (SilverBullet’s Lua dialect), or to use it to create custom Commands, Page Templates or Widgets.\n\n[Much more detail can be found on silverbullet.md](https://silverbullet.md)\n\n## Installing SilverBullet\nCheck out the [instructions](https://silverbullet.md/Install).\n\n## Developing SilverBullet\nSilverBullet's frontend is written in [TypeScript](https://www.typescriptlang.org/) and built on top of the excellent [CodeMirror 6](https://codemirror.net/) editor component. Additional UI is built using [Preact](https://preactjs.com). [ESBuild](https://esbuild.github.io) is used to build the frontend.\n\nThe server backend is written in Go.\n\n## Code structure\n* `client/`: The SilverBullet client, implemented with TypeScript\n* `server/`: The SilverBullet server, written in Go\n* `plugs`: Set of built-in plugs that are distributed with SilverBullet\n* `libraries`: A set of libraries (space scripts, page templates, slash templates) distributed with SilverBullet\n* `plug-api/`: Useful APIs for use in plugs\n  * `lib/`: Useful libraries to be used in plugs\n  * `syscalls/`: TypeScript wrappers around syscalls\n  * `types/`: Various (client) types that can be references from plugs\n* `bin`\n  * `plug_compile.ts` the plug compiler\n* `scripts/`: Useful scripts\n* `website/`: silverbullet.md website content\n\n### Requirements\n* [Node.js](https://nodejs.org/) 24+ and npm 10+: Used to build the frontend and plugs\n* [Go](https://go.dev/): Used to build the backend\n\nThe project includes `.nvmrc` and `.node-version` files. If you use [nvm](https://github.com/nvm-sh/nvm) or another Node version manager, it will automatically use the correct Node.js version:\n\n```shell\nnvm use  # If using nvm\n```\n\nIt's convenient to also install [air](https://github.com/air-verse/air) for development, this will automatically rebuild both the frontend and backend when changes are made:\n\n```shell\ngo install github.com/air-verse/air@latest\n```\nMake sure your `$GOPATH/bin` is in your $PATH.\n\nFirst, install dependencies:\n\n```shell\nmake setup\n```\n\nTo build everything and run the server (which automatically restarts upon file changing):\n\n```shell\nair \u003cPATH-TO-YOUR-SPACE\u003e\n```\n\nAlternatively, to build:\n\n```shell\nmake\n```\n\nTo run the resulting server:\n\n```shell\n./silverbullet \u003cPATH-TO-YOUR-SPACE\u003e\n```\n\n### Useful development tasks\n\n```shell\n# Clean all generated files\nmake clean\n# Typecheck and lint all code\nmake check\n# Format all code\nmake fmt\n# Run all tests\nmake test\n# Run benchmarks\nmake bench\n```\n\n### Build a docker container\nNote, you do not need Node.js nor Go locally installed for this to work:\n\n```shell\ndocker build -t silverbullet .\n```\n\nTo run:\n```shell\ndocker run -p 3000:3000 -v \u003cPATH-TO-YOUR-SPACE\u003e:/space silverbullet\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverbulletmd%2Fsilverbullet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilverbulletmd%2Fsilverbullet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilverbulletmd%2Fsilverbullet/lists"}