Wasabi Documentation
Wasabi Wallet is an open-source, non-custodial, privacy focused Bitcoin wallet for desktop. It implements trustless coin shuffling: Schnorrian CoinJoin.
This is Wasabi Wallet's open source documentation repository. Here 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.
If you would like to support the project by educating other people, this documentation repository is the right place for your efforts! If you have a question regarding the documentation, please open an issue. If you have an answer to a question, please open a pull request. For more details on how to contribute, see the contribution checklist or the to-do list.
If you have a bug regarding the software specifically, please open an issue in Wasabi Wallet's main repository.
The pillars of the documentation
Why Wasabi
Why privacy is important.
An introduction to the over-arching reason why we are so enthusiastic about Bitcoin in general and Wasabi specifically.
Using Wasabi
How to use Wasabi Wallet.
A step by step guide to all the aspects, starting at beginner level, all the way up to power user features and advanced privacy practices.
Building Wasabi
How to contribute to Wasabi.
All the knowledge needed to give new contributors a swift start on their path to black-belt of the Dojo.
Wasabi FAQ
Frequently asked questions.
Most common questions answered with linked reference to the main documentation.
Wasabi Glossary
Glossary.
Explanations of common words used in Wasabi and regarding Bitcoin privacy.
Contribute to the Documentation
Just like the Wasabi wallet software, this documentation is libre and open source under the MIT license. Not only do we appreciate everyone's contribution, but we desperately need it!
VuePress
The Wasabi documentation website is built using an open source static site generator called VuePress. Its configuration and theme are extremely customizable, and it offers great defaults out-of-the-box. Check out the VuePress website for details on how to use it.
To 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.
Know that you do not need to understand/deal with VuePress at all in this case.
Writing Conventions
- Wasabi [capitalized]
- CoinJoin [capitalized, one word]
- Every sentence must start in a new line.
- For a paragraph, add an
empty lineor</br>in the markdown.
Reference files
Please consider this repository structure for hyperlinks, and use relative links whenever possible, for example:
[What is a CoinJoin?](FAQ-Introduction.md#what-is-a-coinjoin)
Embedding images
The images are stored in the /docs/.vuepress/public/ directory.
They can be embedded via the following markdown tags:
Embedding videos
Youtube videos and playlists can be embedded via the following custom markdown tags:
@[youtube](VIDEO_ID)
@[youtubePlaylist](PLAYLIST_ID)Optionally you can also specify the start position of a video in seconds (e.g. starts at 100 seconds):
@[youtube](VIDEO_ID,100)And the index of the video of a playlist (e.g. starts the third video):
@[youtubePlaylist](PLAYLIST_ID,VIDEO_ID)Text Highlights
There are three types of text highlights that can be used to display different colored boxes.
A green box displaying a friendly tip:
:::tip
foo
:::
A yellow box with a cautious warning:
:::warning
foo
:::
A red box with a clear danger, you can also add a title foo to any container:
:::danger foo
bar
:::
Frequently asked questions
Use this markdown box with the headers to write the FAQ:
:::details
### question
answer answer answer.
answer answer answer.
:::
When you want to highlight text within a question, then you need to nest containers by adding more : for the outer block start/end. The outer details container has now four ::::, and the inner warning container has still three :::.
::::details
### question
answer answer answer.
:::warning
answer answer answer.
:::
::::
Variables
To 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}).
These variables are managed in docs/.vuepress/variables.js.
Occurrences of ${variableName} get substituted before the Markdown is processed.
Thanks goes to the Wasabikas, Osu!
Checkout what each emoji means here.
This project follows the all-contributors specification.
Build the Documentation Locally
In order to build the website locally, you'll need Node.js >= 10.16 (or basically the latest LTS version).
Serve locally
- Install dependencies
- Serve locally (by default on port 8080)
npm install
npm start