Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
43 changes: 0 additions & 43 deletions .github/workflows/build.yml

This file was deleted.

19 changes: 4 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,6 @@
# Dependencies
node_modules
backup/
.venv/
site/
.cache/

# Production
/docs/.vuepress/dist

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*

# VSCode
.vscode
3 changes: 0 additions & 3 deletions .gitmodules

This file was deleted.

1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.13
117 changes: 2 additions & 115 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,116 +1,3 @@
# bitcoindevkit.org
# Readme

[![Build Status](https://github.com/bitcoindevkit/bitcoindevkit.org/workflows/Build/badge.svg)](https://github.com/bitcoindevkit/bitcoindevkit.org/actions?query=workflow%3A%22Build%22)

### Build the Documentation Locally

In order to build the website locally, you'll need [Node.js](https://nodejs.org/) >= 14.16 (or basically the latest LTS version).

The setup is straightforward:

```bash
# Install dependencies
npm install

# 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 BDK
tags:
- Bitcoin
- BDK
---
# BDK integration

This document explains how to **integrate BDK into your stack**.
```

### Embedding YouTube videos

To add a YouTube video with a preview, you can do so by linking to it like this:

```md
[![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)
```

Note that the link item needs to be a preview image (either from YouTube or a custom one) to result in an embedded video.

### Check for broken links

The GitHub Actions pipeline checks for broken links after deploying the production site.
You can also run the link check locally using `npm run linkcheck:local`.
The dev server needs to be running alongside for this to work.

## Generating docs-rs

To create or re-create the contents of `static/docs-rs/bdk/<release>`, copy the contents of
the `bdk/target/doc` directory after running the below commands from the `bdk` project directory:

```bash
cargo clean
cargo +nightly rustdoc --features=compiler,electrum,esplora,compact_filters,key-value-db -- --cfg docsrs
```

A nightly toolchain is required because some cool features, like `intra_rustdoc_links` and `doc_cfg`, are still
unstable.

## Adding a blog post

Add a markdown file to `content/blog/<year/<name>.md`. At the beginning of the file add the following header:

```yaml
---
title: "<post title>"
description: "<post description>"
author: "<author>"
date: "<date in yyyy-mm-dd format>"
tags: ["<tag1>", "<tag2>"]
hidden: true
draft: false
---

```

After that header you can type your post using markdown.

The title will be shown on top of the page, together with the list of tags. The description won't be shown, it's only used
in the HTML metadata, so if you want to show it, you will have to copy it as part of the content that comes after the header.

If you need to add static data like pictures you can make a folder called `static/blog/<year>/<name>` and store everything you need in there.
The main website for the Bitcoin Dev Kit Foundation.
8 changes: 0 additions & 8 deletions content/authors/alekos-filini/_index.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/authors/daniela-brozzoni/_index.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/authors/gabriele-domenichini/_index.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/authors/rajarshi-maitra/_index.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/authors/riccardo-casatta/_index.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/authors/sandipan-dey/_index.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/authors/steve-myers/_index.md

This file was deleted.

8 changes: 0 additions & 8 deletions content/authors/thunderbiscuit/_index.md

This file was deleted.

Loading