Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightningdevkit/lightningdevkit.org
Lightning Development Kit Documentation
https://github.com/lightningdevkit/lightningdevkit.org
bitcoin lightning-network
Last synced: 7 days ago
JSON representation
Lightning Development Kit Documentation
- Host: GitHub
- URL: https://github.com/lightningdevkit/lightningdevkit.org
- Owner: lightningdevkit
- License: mit
- Created: 2021-01-29T20:43:12.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T16:01:35.000Z (7 months ago)
- Last Synced: 2024-04-15T13:58:20.633Z (7 months ago)
- Topics: bitcoin, lightning-network
- Homepage: https://lightningdevkit.org
- Size: 17.1 MB
- Stars: 55
- Watchers: 10
- Forks: 41
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md
Awesome Lists containing this project
README
# Lightning Dev Kit Documentation
[](https://github.com/lightningdevkit/lightningdevkit.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 straight forward:
```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 LDK
tags:
- WooCommerce
- WordPress
- Plugin
- eCommerce
---
# LDK integration
This document explains how to **integrate LDK into your stack**.
```
### Embedding YouTube videos
To add a YouTube video with a preview, you can so 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.
### 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.