{"id":19143104,"url":"https://github.com/btcpayserver/btcpayserver-doc","last_synced_at":"2025-05-15T04:06:37.646Z","repository":{"id":38154314,"uuid":"101657836","full_name":"btcpayserver/btcpayserver-doc","owner":"btcpayserver","description":"BTCPay Server Official Documentation","archived":false,"fork":false,"pushed_at":"2025-05-14T13:30:50.000Z","size":399883,"stargazers_count":399,"open_issues_count":23,"forks_count":271,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-05-14T14:53:14.303Z","etag":null,"topics":["btcpayserver","documentation"],"latest_commit_sha":null,"homepage":"https://docs.btcpayserver.org","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/btcpayserver.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":"docs/Support.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":"https://foundation.btcpayserver.org"}},"created_at":"2017-08-28T15:28:45.000Z","updated_at":"2025-05-14T13:29:05.000Z","dependencies_parsed_at":"2024-12-07T11:00:53.840Z","dependency_job_id":"73b009eb-b899-4321-8617-804163cb0a35","html_url":"https://github.com/btcpayserver/btcpayserver-doc","commit_stats":{"total_commits":2673,"total_committers":152,"mean_commits":"17.585526315789473","dds":0.8612046389824167,"last_synced_commit":"8ef500a18b26f9dba786abf11e92e0ca3cb3a7b3"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btcpayserver%2Fbtcpayserver-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btcpayserver%2Fbtcpayserver-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btcpayserver%2Fbtcpayserver-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/btcpayserver%2Fbtcpayserver-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/btcpayserver","download_url":"https://codeload.github.com/btcpayserver/btcpayserver-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254270646,"owners_count":22042859,"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":["btcpayserver","documentation"],"created_at":"2024-11-09T07:29:35.222Z","updated_at":"2025-05-15T04:06:32.630Z","avatar_url":"https://github.com/btcpayserver.png","language":"Shell","funding_links":["https://foundation.btcpayserver.org"],"categories":[],"sub_categories":[],"readme":"# BTCPay Server Documentation\n\n[![Build Status](https://github.com/btcpayserver/btcpayserver-doc/workflows/Build/badge.svg)](https://github.com/btcpayserver/btcpayserver-doc/actions/workflows/build.yml)\n\n## Introduction\n\nBTCPay Server is an open-source, self-hosted payment processor for Bitcoin and other cryptocurrencies.\n\nIf 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.\n\nOnly 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.\n\nPlease check out our [official website](https://btcpayserver.org/), [complete documentation](https://docs.btcpayserver.org/) and [FAQ](https://docs.btcpayserver.org/FAQ/) for more details.\n\n## Contributing\n\nPull requests are welcome and appreciated. To contribute to BTCPay Server, first check the [contributing guidelines](docs/Contribute/README.md).\n\nIf you're a beginner, take a look at the step by step guide on how to contribute to BTCPay Server documentation below.\n\n[![Contributing to Documentation](https://img.youtube.com/vi/bSDROcdSSWw/mqdefault.jpg)](https://www.youtube.com/watch?v=bSDROcdSSWw)\n\n### Build the Documentation Locally\n\nIn order to build the website locally, you'll need [Node.js](https://nodejs.org/) \u003e= 12.16 (or basically the latest LTS version).\nA prerequisite for the `setup-deps.sh` script is [jq](https://stedolan.github.io/jq/).\n\nThe setup is straight forward:\n\n```bash\n# Install dependencies\nnpm install\n\n# Link external doc repos\n./setup-deps.sh\n\n# Serve locally (by default on port 8080)\nnpm start\n```\n\n### Text Highlights\n\nThere are [three types of text highlights](https://vuepress.vuejs.org/guide/markdown.html#custom-containers) that can be used to display different colored boxes.\n\nA green box displaying a friendly tip:\n\n```md\n:::tip\nfoo\n:::\n```\n\nA yellow box with a cautious warning:\n\n```md\n:::warning\nfoo\n:::\n```\n\nA red box with a clear danger, you can also add a title `foo` to any container:\n\n```md\n:::danger foo\nbar\n:::\n```\n\n### SEO improvements\n\nWe 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.\n\nTo improve the meta attributes of a specific page, you can add them as YAML frontmatter like this: (see the WooCommerce page for an example)\n\n```text\n---\ndescription: How to integrate BTCPay Server into your WooCommerce store.\ntags:\n- WooCommerce\n- WordPress\n- Plugin\n- eCommerce\n---\n# WooCommerce integration\n\nThis document explains how to **integrate BTCPay Server into your WooCommerce store**.\n```\n\n### Embedding YouTube videos\n\nTo add a YouTube video with a preview, you can do so by linking to it like this:\n\n```md\n[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/mqdefault.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)\n```\n\nNote that the link item need to be a preview image (either from YouTube or a custom one) to result in an embedded video.\n\n### External documentation repos\n\nThe build documentation site combines a bunch of docs living in different repositories.\n\nBefore 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.\n\nThe process for that is defined in the [setup-deps.sh](./setup-deps.sh) script.\n\nExternal repos can trigger the docs build whenever they change.\nYou 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:\n\n```sh\ncurl -X POST https://api.github.com/repos/btcpayserver/btcpayserver-doc/dispatches \\\n  -u \"${{ secrets.GH_PAT }}\" \\\n  -H \"Accept: application/vnd.github.everest-preview+json\" \\\n  -H \"Content-Type: application/json\" \\\n  --data '{\"event_type\": \"build_docs\"}'\n```\n\nThe `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).\n\n## Supporters\n\nThe BTCPay Server Project is proudly supported by these entities through the [BTCPay Server Foundation](https://foundation.btcpayserver.org/).\n\n[![Spiral](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_spiral.svg)](https://spiral.xyz)\n[![OpenSats](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_opensats.svg)](https://opensats.org)\n[![Tether](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_tether.svg)](https://tether.to)\n[![Human Rights Foundation](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_hrf.svg)](https://hrf.org)\n[![LunaNode](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_lunanode.svg)](https://lunanode.com)\n[![Wallet of Satoshi](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_walletofsatoshi.svg)](https://walletofsatoshi.com/)\n[![Coincards](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_coincards.svg)](https://coincards.com/)\n[![IVPN](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_ivpn.svg)](https://ivpn.net/)\n[![Unbank](https://raw.githubusercontent.com/btcpayserver/btcpayserver/master/BTCPayServer/wwwroot/img/readme/supporter_unbank.svg)](https://unbank.com/)\n\nIf you'd like to support the project, please visit the [donation page](https://btcpayserver.org/donate/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtcpayserver%2Fbtcpayserver-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbtcpayserver%2Fbtcpayserver-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbtcpayserver%2Fbtcpayserver-doc/lists"}