Skip to content

Commit 33431e5

Browse files
author
doomy
committed
some cleaning and more docs
1 parent af0975a commit 33431e5

4 files changed

Lines changed: 44 additions & 8 deletions

File tree

config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ highlight_theme = "ir-white"
1313
# Whether to build a search index to be used later on by a JavaScript library
1414
build_search_index = true
1515

16-
title = "RustAudio"
16+
title = "Rust Audio"
1717

1818
taxonomies = [
1919
]

content/formats.toml

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,38 @@
11
# Audio plugin formats
22

3+
# Format for specifying a format 🤔
4+
#
5+
# ```
6+
# [[formats]]
7+
#
8+
# # Human readable format name
9+
# name = "MyFormatName"
10+
#
11+
# # Short synopsis of the format
12+
# description = "This format was designed for Plan9 computers only"
13+
#
14+
# # Whether or not the format is permissively licensed
15+
# proprietary = false
16+
#
17+
# # Optionally, list crates that work with this format
18+
# crates = [
19+
# { name = "plan9-plug", url = "https://example.com/mycoolsite/plan9-plugin" },
20+
# ]
21+
#
22+
# # Optionally, list additional resources on this format
23+
# resources = [
24+
# { name = "My link docs name", url = "http://example.com/docs" },
25+
# ]
26+
# ```
27+
328
[[formats]]
4-
# Human readable format name
529
name = "VST"
6-
# Short synopsis of the format
730
description = "VST2 was one of the most common standards, but is now unlicensed. Instead, VST3 is recommended. VSTs are generally supported in most DAWs."
8-
# Whether or not the format is permissively licensed
931
proprietary = true
10-
# Optional crates that work with this format
1132
crates = [
1233
{ name = "vst", url = "https://github.com/RustAudio/vst-rs" },
1334
{ name = "vst3-sys", url = "https://github.com/RustAudio/vst3-sys" },
1435
]
15-
# Optional additional resources on this format
1636
resources = []
1737

1838
[[formats]]

content/resources.toml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
# Resources format
2+
#
3+
# ```
4+
# [[resources]]
5+
#
6+
# A descriptive but short name for the resource
7+
# name = "My resource name"
8+
#
9+
# # Link directly to the resource named
10+
# url = "http://www.example.com/dsp.html"
11+
#
12+
# # Avoid creating new categories unless completely necessary
13+
# category = "general"
14+
# ```
15+
116
[[resources]]
217
name = "The Scientist and Engineer's Guide to Digital Signal Processing"
318
url = "http://www.dspguide.com/"

templates/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ <h3>Community</h3>
2525
<div style="display: flex; gap: 2em;">
2626
<div style="display: flex; flex-direction: column;">
2727
<h4 style="margin: 0;">Discord</h4>
28-
<p>Join RustAudio on Discord to keep up with audio development within the Rust ecosystem, get help with
28+
<p>Join Rust Audio on Discord to keep up with audio development within the Rust ecosystem, get help with
2929
DSP, collaborate on projects, and everything in-between.
3030
</br>
3131
<a class="button" style="margin-top: 1em" href={{config.extra.discord_invite}} target="_blank">Join
@@ -108,7 +108,8 @@ <h2>{{group | capitalize}}</h2>
108108
{# Crates #}
109109

110110
<section>
111-
<h2 class="container-full">RustAudio Crates</h2>
111+
<h2>Projects</h2>
112+
<h2 class="container-full">Rust Audio Crates</h2>
112113
<div class="crates">
113114
{% set crates = load_data(url=config.extra.repos_url, format="json") %}
114115
{% for crate in crates | sort(attribute="updated_at") | reverse %}

0 commit comments

Comments
 (0)