Skip to content

Commit 7082676

Browse files
authored
Update docs (#3)
* Update docs * Add donate * Remove unused deps
1 parent e36f642 commit 7082676

File tree

11 files changed

+156
-29
lines changed

11 files changed

+156
-29
lines changed

blog/authors.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ liuchengxu:
33
url: https://github.com/liuchengxu
44
image_url: https://github.com/liuchengxu.png
55
page: true
6+
title: Subcoin Builder
67
socials:
78
github: liuchengxu

blog/tags.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ hola:
1818
permalink: /hola
1919
description: Hola tag description
2020

21-
sync:
21+
syncing:
2222
label: Syncing
2323
permalink: /syncing
2424
description: Bitcoin syncing

docs/basics/_category_.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
{
2-
"label": "Getting Started",
2+
"label": "🚀 Getting Started",
33
"position": 2,
44
"link": {
55
"type": "generated-index",
6+
"slug": "getting-started",
67
"description": "Subcoin basics"
78
}
89
}

docs/basics/download-UTXO-snapshot.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,22 @@ sidebar_position: 3
44

55
# Download UTXO Snapshot (Coming Soon)
66

7-
Subcoin provides a dedicated tool for downloading Bitcoin Core compatible UTXO snapshot so that Bitcoin Core users don't have to rely on a trusted snapshot provider to do a fast sync in Bitcoin Core.
7+
Subcoin offers a dedicated tool for downloading a Bitcoin Core-compatible UTXO snapshot from the Subcoin P2P network directly. This eliminates the need for Bitcoin Core users to rely on trusted snapshot providers for performing a fast sync.
8+
9+
## Tool: `snapcake`
10+
11+
To download the UTXO snapshot, simply use the following command:
12+
13+
```bash
14+
snapcake
15+
```
16+
17+
## Using the Snapshot in Bitcoin Core
18+
19+
Once the snapshot is successfully downloaded, it can be loaded into your Bitcoin Core node using the `loadtxoutset` RPC command:
820

921
```bash
10-
subcoin-snapshot-tool
22+
bitcoin-cli loadtxoutset <path-to-snapshot-file>
1123
```
24+
25+
This process initializes your Bitcoin Core node with a recent UTXO set, allowing you to sync quickly to the network tip without the need to process historical blocks. This can significantly reduce the time required to get a fully functional bitcoind instance.

docs/donate.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
id: donate
3+
title: Donate to Subcoin
4+
sidebar_label: 💰 Donate
5+
sidebar_position: 4
6+
---
7+
8+
# Donate to Subcoin
9+
10+
Thank you for considering a donation to support Subcoin! Your contributions help us build innovative solutions that integrate Bitcoin with Substrate, bringing decentralized fast sync and more efficient tools to the Bitcoin ecosystem.
11+
12+
Every contribution, no matter the size, makes a difference.
13+
14+
---
15+
16+
## Why Donate?
17+
18+
By donating, you’re helping us:
19+
20+
- Improve the decentralized Bitcoin fast sync supported by Subcoin.
21+
- Develop tools like `snapcake` to enhance the Bitcoin Core software.
22+
- Build a robust and decentralized future for Bitcoin users.
23+
24+
We are deeply grateful for your support and look forward to building a better blockchain ecosystem together.
25+
26+
---
27+
28+
## How to Donate
29+
30+
You can support us by sending donations in either **Bitcoin (BTC)** or **Polkadot (DOT)**.
31+
32+
- **BTC**: `bc1p9nvx58550rlhk29a6urzxg06hmgv9sh5afwdt66md09xwpdytlmqun0j4v`
33+
- **DOT**: `12uXLCZZkprwRBhfmhTXdfQE8faQwgNpS76wwmnEbgDwWB9e`
34+
35+
---
36+
37+
For inquiries or other ways to contribute, feel free to [contact us](mailto:support@xuliuchengxlc@gmail.com).

docs/extras/_category_.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
{
2-
"label": "Extras",
2+
"label": "Extras",
33
"position": 3,
44
"link": {
5-
"type": "generated-index"
5+
"type": "generated-index",
6+
"slug": "extras",
67
}
78
}

docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 1
33
---
44

5-
# Introduction
5+
# 📘 Introduction
66

77
Welcome to **Subcoin**, an innovative project aimed at introducing decentralized fast sync for the Bitcoin network. By leveraging the power of [Polkadot-SDK (formerly Substrate)](https://github.com/paritytech/polkadot-sdk), Subcoin delivers a more efficient Bitcoin chain syncing process.
88

docusaurus.config.js

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ const config = {
7979
navbar: {
8080
title: 'Subcoin',
8181
logo: {
82-
alt: 'My Site Logo',
83-
src: 'img/logo.svg',
82+
alt: 'Subcoin Logo',
83+
src: 'img/subcoin-logo.svg',
8484
},
8585
items: [
8686
{to: '/blog', label: 'Blog', position: 'left'},
@@ -95,10 +95,18 @@ const config = {
9595
label: 'Dev Guide',
9696
position: 'left',
9797
},
98+
{to: '/docs/donate', label: 'Donate', position: 'left'},
9899
{
99100
href: 'https://github.com/subcoin-project/subcoin',
100-
label: 'GitHub',
101101
position: 'right',
102+
className: 'header-github-link',
103+
'aria-label': 'GitHub repository',
104+
},
105+
{
106+
href: 'https://x.com/subcoin_project',
107+
position: 'right',
108+
className: 'header-twitter-link',
109+
'aria-label': 'Twitter profile',
102110
},
103111
],
104112
},

src/css/custom.css

Lines changed: 81 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,91 @@
44
* work well for content-centric websites.
55
*/
66

7-
/* You can override the default Infima variables here. */
7+
/* Colors are generated from https://aicolors.co/ and adjusted by ChatGPT. */
88
:root {
9-
--ifm-color-primary: #2e8555;
10-
--ifm-color-primary-dark: #29784c;
11-
--ifm-color-primary-darker: #277148;
12-
--ifm-color-primary-darkest: #205d3b;
13-
--ifm-color-primary-light: #33925d;
14-
--ifm-color-primary-lighter: #359962;
15-
--ifm-color-primary-lightest: #3cad6e;
9+
/* Primary Colors */
10+
--ifm-color-primary: #2C3E50; /* primary-100 */
11+
--ifm-color-primary-dark: #57687c; /* primary-200 */
12+
--ifm-color-primary-darker: #b4c7dd; /* primary-300 */
13+
--ifm-color-primary-light: #F7CAC9; /* accent-100 */
14+
--ifm-color-primary-lighter: #926b6a; /* accent-200 */
15+
16+
/* Link Colors */
17+
--ifm-link-color: #1E6091; /* Distinct blue link color */
18+
--ifm-link-hover-color: #144c73; /* Darker shade for hover */
19+
20+
/* Text Colors */
21+
--ifm-color-content: #333333; /* text-100 */
22+
--ifm-color-content-secondary: #5c5c5c; /* text-200 */
23+
24+
/* Background Colors */
25+
--ifm-background-color: #F2F2F2; /* bg-100 */
26+
--ifm-background-secondary-color: #e8e8e8; /* bg-200 */
27+
--ifm-background-alt: #bfbfbf; /* bg-300 */
28+
29+
/* Code Font Size and Highlighting */
1630
--ifm-code-font-size: 95%;
1731
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
1832
}
1933

20-
/* For readability concerns, you should choose a lighter palette in dark mode. */
34+
/* Dark mode adjustments */
2135
[data-theme='dark'] {
22-
--ifm-color-primary: #25c2a0;
23-
--ifm-color-primary-dark: #21af90;
24-
--ifm-color-primary-darker: #1fa588;
25-
--ifm-color-primary-darkest: #1a8870;
26-
--ifm-color-primary-light: #29d5b0;
27-
--ifm-color-primary-lighter: #32d8b4;
28-
--ifm-color-primary-lightest: #4fddbf;
29-
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
36+
/* Primary Colors */
37+
--ifm-color-primary: #926b6a; /* accent-200 */
38+
--ifm-color-primary-dark: #2C3E50; /* primary-100 */
39+
--ifm-color-primary-darker: #57687c; /* primary-200 */
40+
--ifm-color-primary-light: #F7CAC9; /* accent-100 */
41+
--ifm-color-primary-lighter: #b4c7dd; /* primary-300 */
42+
43+
/* Link Colors */
44+
--ifm-link-color: #6cb2eb; /* Light blue for dark mode */
45+
--ifm-link-hover-color: #4a93c9; /* Slightly darker for hover */
46+
47+
/* Text Colors */
48+
--ifm-color-content: #F2F2F2; /* lightened text-100 for dark mode */
49+
--ifm-color-content-secondary: #e8e8e8; /* bg-200 */
50+
51+
/* Background Colors */
52+
--ifm-background-color: #333333; /* darkened text-100 as background */
53+
--ifm-background-secondary-color: #5c5c5c; /* darkened text-200 as secondary */
54+
--ifm-background-alt: #bfbfbf; /* bg-300 */
55+
56+
/* Code highlighting adjustments */
57+
--docusaurus-highlighted-code-line-bg: rgba(255, 255, 255, 0.15);
58+
}
59+
60+
/* GitHub icon */
61+
.header-github-link {
62+
padding-left: 10px;
63+
}
64+
65+
.header-github-link:hover {
66+
opacity: 0.6;
67+
}
68+
69+
.header-github-link::before {
70+
content: '';
71+
width: 24px;
72+
height: 24px;
73+
display: flex;
74+
background: url("data:image/svg+xml,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E")
75+
no-repeat;
76+
}
77+
78+
/* Twitter icon */
79+
.header-twitter-link {
80+
padding-left: 10px;
81+
}
82+
83+
.header-twitter-link:hover {
84+
opacity: 0.6;
85+
}
86+
87+
.header-twitter-link::before {
88+
content: '';
89+
width: 24px;
90+
height: 24px;
91+
display: flex;
92+
background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512'%3E%3Cpath fill='%231da1f2' d='M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z'/%3E%3C/svg%3E")
93+
no-repeat;
3094
}

src/pages/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ export default function Home() {
3535
const {siteConfig} = useDocusaurusContext();
3636
return (
3737
<Layout
38-
title={`Hello from ${siteConfig.title}`}
39-
description="Description will go into a meta tag in <head />">
38+
title={`Bitcoin Node in Substrate`}
39+
description="Subcoin is a Rust Bitcoin Full Node in Substrate, featured in Decentralized Fast Sync. />">
4040
<HomepageHeader />
4141
<main>
4242
<HomepageFeatures />

0 commit comments

Comments
 (0)