{"id":18814057,"url":"https://github.com/walletwasabi/wasabidoc","last_synced_at":"2025-04-13T11:48:17.151Z","repository":{"id":35543669,"uuid":"197537954","full_name":"WalletWasabi/WasabiDoc","owner":"WalletWasabi","description":"This is the Wasabi documentation, an archive of knowledge about the open-source, non-custodial and privacy-focused Bitcoin wallet for desktop.","archived":false,"fork":false,"pushed_at":"2024-10-29T18:04:16.000Z","size":97136,"stargazers_count":100,"open_issues_count":35,"forks_count":84,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-10-29T20:10:51.034Z","etag":null,"topics":["bitcoin","coinjoin","documentation","faq","guide","how-to","privacy","tutorial","wallet","wasabi"],"latest_commit_sha":null,"homepage":"https://docs.wasabiwallet.io","language":null,"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/WalletWasabi.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}},"created_at":"2019-07-18T07:44:17.000Z","updated_at":"2024-10-29T18:03:46.000Z","dependencies_parsed_at":"2023-02-18T17:30:59.301Z","dependency_job_id":"dd277796-42ca-4bab-bbb9-b7f747ee7eb8","html_url":"https://github.com/WalletWasabi/WasabiDoc","commit_stats":null,"previous_names":["walletwasabi/wasabidoc"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalletWasabi%2FWasabiDoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalletWasabi%2FWasabiDoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalletWasabi%2FWasabiDoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WalletWasabi%2FWasabiDoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WalletWasabi","download_url":"https://codeload.github.com/WalletWasabi/WasabiDoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248710410,"owners_count":21149186,"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":["bitcoin","coinjoin","documentation","faq","guide","how-to","privacy","tutorial","wallet","wasabi"],"created_at":"2024-11-07T23:39:14.108Z","updated_at":"2025-04-13T11:48:17.133Z","avatar_url":"https://github.com/WalletWasabi.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wasabi Wallet 2.0 Documentation\n\n[Wasabi Wallet](https://wasabiwallet.io) is an open-source, non-custodial, privacy focused Bitcoin wallet for desktop. It implements a trustless privacy technique, called [WabiSabi CoinJoin](https://eprint.iacr.org/2021/206).\n\nThis is Wasabi Wallet's open-source [documentation](https://docs.wasabiwallet.io) repository.\nHere you will find information about the nuances of privacy in Bitcoin, how Wasabi solves some of the existing problems, and how you can use this tool to defend yourself.\n\nIf you would like to support the project by educating other people, this documentation repository is the right place for your efforts!\nIf you have a question regarding the documentation, please [open an issue](https://github.com/WalletWasabi/WasabiDoc/issues).\nIf you have an answer to a question, please [open a pull request](https://github.com/WalletWasabi/WasabiDoc/pulls).\nFor more details on how to contribute, see the [contribution checklist](https://docs.wasabiwallet.io/building-wasabi/ContributionChecklist.html).\n\nIf you need help regarding the software specifically, please check out [Discussions](https://github.com/WalletWasabi/WalletWasabi/discussions) in Wasabi Wallet's [main repository](https://github.com/WalletWasabi/WalletWasabi).\n\n[![Build Status](https://dev.azure.com/zkSNACKs/WasabiDoc/_apis/build/status/zkSNACKs.WasabiDoc?branchName=master)](https://dev.azure.com/zkSNACKs/WasabiDoc/_build/latest?definitionId=4\u0026branchName=master)\n\n---\n\n# 🏛️ The pillars of the documentation\n\n* ## [Getting Started](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/getting-started/)\n  * Getting started guide.\n* ## [Why Wasabi](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/why-wasabi/)\n  * Why privacy is important.\n* ## [Using Wasabi](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/using-wasabi/)\n  * How to use Wasabi Wallet.\n* ## [Building Wasabi](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/building-wasabi/)\n  * How to contribute to Wasabi.\n* ## [Wasabi FAQ](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/FAQ/)\n  * Frequently asked questions.\n* ## [Wasabi Glossary](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/glossary/)\n  * Explanations of common words.\n\n---\n\n# 📄 Contribute to the Documentation\n\nJust like the Wasabi Wallet software, this documentation is libre and open-source under the [MIT license](LICENSE).\nNot only do we appreciate everyone's contribution, but we desperately need it!\n\n* [VuePress](#vuepress)\n* [Writing Conventions](#writing-conventions)\n* [Reference files](#reference-files)\n* [Embedding images](#embedding-images)\n* [Embedding videos](#embedding-videos)\n* [Text Highlights](#text-highlights)\n* [Frequently asked questions](#frequently-asked-questions)\n* [Variables](#variables)\n\n---\n\n## VuePress\n\nThe [Wasabi documentation website](https://docs.wasabiwallet.io) is built using an open-source static site generator called VuePress.\nIts [configuration](https://github.com/WalletWasabi/WasabiDoc/blob/master/docs/.vuepress/config.js) and [theme](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/.vuepress/styles) are extremely customizable, and it offers great defaults out-of-the-box.\nCheck out the [VuePress website](https://v1.vuepress.vuejs.org/) for details on how to use it.\n\nTo contribute to the content of the website, you can make PRs related to the markdown files in the `/docs/` directory, and if merged, the changes will automatically be integrated into the documentation website by VuePress.\nKnow that you do not need to understand/deal with VuePress at all in this case.\n\n## Writing Conventions\n\n- Wasabi [capitalized]\n- coinjoin [not capitalized, one word]\n- WabiSabi [capitalized, one word]\n- Every sentence must start in a new line.\n- For a paragraph, add an `empty line` or `\u003cbr\u003e` in the markdown.\n\n## Reference files\n\nPlease consider this repository structure for hyperlinks, and use relative links whenever possible, for example:\n\n```\n[What is a coinjoin?](FAQ-Introduction.md#what-is-a-coinjoin)\n```\n\n## Embedding images\n\nThe images are stored in the [`/docs/.vuepress/public/`](https://github.com/WalletWasabi/WasabiDoc/tree/master/docs/.vuepress/public) directory.\nThey can be embedded via the following markdown tags:\n\n```\n![Alternative text of the image](/IMAGENAME.png \"Title of the image\")\n```\n\n## Embedding videos\n\nYoutube videos and playlists can be embedded via the following custom markdown tags:\n\n```md\n[![Title of the video](https://img.youtube.com/vi/VIDEO_ID/maxresdefault.jpg)](https://youtu.be/VIDEO_ID)\n```\n\nOptionally you can also specify the start position of a video in seconds (e.g. starts at 100 seconds):\n\n```md\n[![Title of the video](https://img.youtube.com/vi/VIDEO_ID/maxresdefault.jpg)](https://youtu.be/VIDEO_ID?t=123)\n```\n\nAnd the index of the video of a playlist (e.g. starts the third video):\n\n```md\n[![Title of the playlist](https://img.youtube.com/vi/VIDEO_ID/maxresdefault.jpg)](https://youtu.be/VIDEO_ID?list=PLAYLIST_ID)\n```\n\nIf the image doesn't appear, that usually happens with older videos, use hqdefault.jpg instead of maxresdefault.jpg\n\nIn case that the thumbnail doesn't fit well with the documentation, a default image can be added as custom thumbnail, located at `/Logo_without_text_with_bg_dark_with_yt.png`.\nCurrently, all thumbnails have been set to this default image as a temporary solution because videos are old, sometimes not under our control, and the thumbnails were irrelevant.\n\n## Text Highlights\n\nThere are three types of text highlights that can be used to display different colored boxes.\n\nA green box displaying a [friendly tip](https://docs.wasabiwallet.io/using-wasabi/PasswordBestPractices.html):\n\n```\n:::tip\nfoo\n:::\n```\n\nA yellow box with a [cautious warning](https://docs.wasabiwallet.io/using-wasabi/WalletRecovery.html#back-up-wallet-file-and-password):\n\n```\n:::warning\nfoo\n:::\n```\n\nA red box with a [clear danger](https://docs.wasabiwallet.io/using-wasabi/ExternalRestore.html), you can also add a title `foo` to any container:\n\n```\n:::danger foo\nbar\n:::\n```\n\n## Frequently asked questions\n\nUse this markdown box with the headers to write the FAQ:\n```\n### question\n\nanswer answer answer.\nanswer answer answer.\n```\n\n## Variables\n\nTo have a single place to maintain universal strings like the current Wasabi version number, we use variables in the Markdown (i.e.  `${currentVersion}`and `${zksnacksPublicKeyFingerprint}`).\nThese variables are managed in [`docs/.vuepress/config.ts`](https://github.com/WalletWasabi/WasabiDoc/blob/master/docs/.vuepress/config.ts).\nOccurrences of `${variableName}` get substituted before the Markdown is processed.\n\n# Build the Documentation Locally\n\nIn order to build the website locally, you'll need [Node.js](https://nodejs.org/) \u003e= 10.16 (or basically the latest LTS version).\n\n## Serve locally\n\n1. Install dependencies\n2. Serve locally (by default on port 8080)\n\n```bash\nnpm install\nnpm start\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalletwasabi%2Fwasabidoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwalletwasabi%2Fwasabidoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwalletwasabi%2Fwasabidoc/lists"}