Skip to content

Commit e33c539

Browse files
committed
Migrate docs to mdBook.
1 parent 6df3d98 commit e33c539

File tree

15 files changed

+25
-339
lines changed

15 files changed

+25
-339
lines changed

.github/workflows/site.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,17 +37,15 @@ jobs:
3737
- name: Setup Pages
3838
id: pages
3939
uses: actions/configure-pages@v5
40-
- name: Build with Jekyll
41-
run: |
42-
bundle install
43-
bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
40+
- name: Install mdBook
41+
run: cargo install mdbook
42+
- name: Build with mdBook
43+
run: ~/.cargo/bin/mdbook build
4444
working-directory: ./docs
45-
env:
46-
JEKYLL_ENV: production
4745
- name: Upload artifact
4846
uses: actions/upload-pages-artifact@v3
4947
with:
50-
path: ./docs/_site
48+
path: ./docs/book
5149
deploy-site:
5250
environment:
5351
name: github-pages

docs/.gitignore

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1 @@
1-
_site
2-
.sass-cache
3-
.jekyll-cache
4-
.jekyll-metadata
5-
vendor
1+
book

docs/404.html

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/Gemfile

Lines changed: 0 additions & 35 deletions
This file was deleted.

docs/Gemfile.lock

Lines changed: 0 additions & 191 deletions
This file was deleted.

docs/_config.yml

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/book.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[book]
2+
authors = []
3+
language = "en"
4+
src = "src"
5+
title = "JACK"

docs/src/SUMMARY.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Summary
2+
3+
- [Quickstart](./quickstart.md)
4+
- [Features](./features.md)
5+
- [Logging](./logging.md)
6+
- [Contrib](./contrib/index.md)
7+
- [Closure Callbacks](./contrib/closure_callbacks.md)
8+

docs/contrib/closure_callbacks.md renamed to docs/src/contrib/closure_callbacks.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,14 @@
1-
---
2-
layout: page
3-
title: Closure Callbacks
4-
parent: Contrib
5-
permalink: /closure-callbacks
6-
nav_order: 1
7-
---
8-
91
# Closure Callbacks
102

113
Closure callbacks allow you to define functionality inline.
124

135
## Process Closure
146

15-
The typical use case for a process closure involves creating a closure that
16-
contains captures the required state and then activating it.
7+
Audio and midi processing can be defined through closures. This involves:
8+
9+
1. Creating a closure that captures the appropriate state (including JACK ports)
10+
and
11+
1. Activating it within a client.
1712

1813
```rust
1914
// 1. Create the client.
Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
---
2-
layout: page
3-
title: Contrib
4-
permalink: /contrib
5-
nav_order: 3
6-
---
7-
81
# Contrib
92

103
`jack::contrib` contains convenient but optional utilities.

docs/features.md renamed to docs/src/features.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
---
2-
layout: page
3-
title: Features
4-
permalink: /features
5-
nav_order: 1
6-
---
7-
81
# Features
92

103
The Rust features for the `jack` crate are defined in

docs/src/jack-server-architecture.png

14.1 KB
Loading

docs/logging.md renamed to docs/src/logging.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,3 @@
1-
---
2-
layout: page
3-
title: Logging
4-
permalink: /logging
5-
nav_order: 2
6-
---
7-
81
# Logging
92

103
JACK can communicate info and error messages. By default, the [log
File renamed without changes.

0 commit comments

Comments
 (0)