Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/btcpayserver/btcpayserver-doc
BTCPay Server Official Documentation
https://github.com/btcpayserver/btcpayserver-doc
btcpayserver documentation
Last synced: 8 days ago
JSON representation
BTCPay Server Official Documentation
- Host: GitHub
- URL: https://github.com/btcpayserver/btcpayserver-doc
- Owner: btcpayserver
- Created: 2017-08-28T15:28:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-11-30T20:27:43.000Z (22 days ago)
- Last Synced: 2024-12-07T11:01:56.750Z (15 days ago)
- Topics: btcpayserver, documentation
- Language: Shell
- Homepage: https://docs.btcpayserver.org
- Size: 339 MB
- Stars: 386
- Watchers: 21
- Forks: 261
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: docs/Support.md
Awesome Lists containing this project
README
# BTCPay Server Documentation
[](https://github.com/btcpayserver/btcpayserver-doc/actions/workflows/build.yml)
## Introduction
BTCPay Server is an open-source, self-hosted payment processor for Bitcoin and other cryptocurrencies.
If you have trouble using BTCPay Server, consider joining the [communities listed on the official website](https://btcpayserver.org/#communityCTA) to get help from community members.
Only file a [Github issue](https://github.com/btcpayserver/btcpayserver/issues) for technical issues you can't resolve through other channels or feature requests you've validated with other members of community.
Please check out our [official website](https://btcpayserver.org/), [complete documentation](https://docs.btcpayserver.org/) and [FAQ](https://docs.btcpayserver.org/FAQ/) for more details.
## Contributing
Pull requests are welcome and appreciated. To contribute to BTCPay Server, first check the [contributing guidelines](docs/Contribute/README.md).
If you're a beginner, take a look at the step by step guide on how to contribute to BTCPay Server documentation below.
[](https://www.youtube.com/watch?v=bSDROcdSSWw)
### Build the Documentation Locally
In order to build the website locally, you'll need [Node.js](https://nodejs.org/) >= 12.16 (or basically the latest LTS version).
A prerequisite for the `setup-deps.sh` script is [jq](https://stedolan.github.io/jq/).
The setup is straight forward:
```bash
# Install dependencies
npm install
# Link external doc repos
./setup-deps.sh
# Serve locally (by default on port 8080)
npm start
```
### Text Highlights
There are [three types of text highlights](https://vuepress.vuejs.org/guide/markdown.html#custom-containers) that can be used to display different colored boxes.
A green box displaying a friendly tip:
```md
:::tip
foo
:::
```
A yellow box with a cautious warning:
```md
:::warning
foo
:::
```
A red box with a clear danger, you can also add a title `foo` to any container:
```md
:::danger foo
bar
:::
```
### SEO improvements
We are using the [Vuepress SEO plugin](https://www.npmjs.com/package/vuepress-plugin-seo) to add relevant meta tags to the site and individual pages.
To improve the meta attributes of a specific page, you can add them as YAML frontmatter like this: (see the WooCommerce page for an example)
```text
---
description: How to integrate BTCPay Server into your WooCommerce store.
tags:
- WooCommerce
- WordPress
- Plugin
- eCommerce
---
# WooCommerce integration
This document explains how to **integrate BTCPay Server into your WooCommerce store**.
```
### Embedding YouTube videos
To add a YouTube video with a preview, you can do so by linking to it like this:
```md
[](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
```
Note that the link item need to be a preview image (either from YouTube or a custom one) to result in an embedded video.
### External documentation repos
The build documentation site combines a bunch of docs living in different repositories.
Before the build we check out the other repositories, copy their docs into the right places and link them just as the docs in this repo.
The process for that is defined in the [setup-deps.sh](./setup-deps.sh) script.
External repos can trigger the docs build whenever they change.
You can use GitHub's [repository_dispatch](https://help.github.com/en/actions/reference/events-that-trigger-workflows#external-events-repository_dispatch) feature for this, which is exposed via the API:
```sh
curl -X POST https://api.github.com/repos/btcpayserver/btcpayserver-doc/dispatches \
-u "${{ secrets.GH_PAT }}" \
-H "Accept: application/vnd.github.everest-preview+json" \
-H "Content-Type: application/json" \
--data '{"event_type": "build_docs"}'
```
The `GH_PAT` needs to be a [personal access token](https://help.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token).
## Supporters
The BTCPay Server Project is proudly supported by these entities through the [BTCPay Server Foundation](https://foundation.btcpayserver.org/).
[](https://spiral.xyz)
[](https://opensats.org)
[](https://www.bailliegifford.com)
[](https://tether.to)
[](https://hrf.org)
[](https://lunanode.com)
[](https://walletofsatoshi.com/)
[](https://coincards.com/)
[](https://ivpn.net/)
[](https://unbank.com/)
If you'd like to support the project, please visit the [donation page](https://btcpayserver.org/donate/).