Skip to content

Commit

Permalink
Add initial docs, Rust snippets
Browse files Browse the repository at this point in the history
  • Loading branch information
ok300 committed Jun 27, 2024
1 parent 61212dc commit 7529d52
Show file tree
Hide file tree
Showing 37 changed files with 8,800 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,18 @@
# breez-sdk-liquid-docs
# Introduction

The SDK docs are live at TODO.

## Contributions

For syntax and supported features, see [https://rust-lang.github.io/mdBook](https://rust-lang.github.io/mdBook).

## Develop

To locally serve the docs run:

```bash
cargo install mdbook
cargo install --path ./snippets-processor
mdbook build
mdbook serve --open
```
17 changes: 17 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[book]
language = "en"
multilingual = true
src = "src"
title = "Breez SDK Liquid Docs"

[output.html]
theme="theme"
additional-js = ["tabs.js"]
git-repository-url = "https://github.com/breez/breez-sdk-liquid-docs"
edit-url-template = "https://github.com/breez/breez-sdk-liquid-docs/edit/main/{path}"

[output.html.print]
enable = false

[preprocessor.snippets]
after = ["links"]
1 change: 1 addition & 0 deletions snippets-processor/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
target
Loading

0 comments on commit 7529d52

Please sign in to comment.