Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add fallback docs for crates #152

Merged
merged 2 commits into from
Jan 10, 2025
Merged

add fallback docs for crates #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62fd465
add fallback docs deserialisation (#152)
poopsicles Jan 10, 2025
5a700f8
add docs to crates (#152)
poopsicles Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions data/crates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,7 @@
"recommendations": [{
"name": "rustup",
"link": "https://rustup.rs",
"docs": "https://rust-lang.github.io/rustup",
"notes": "Install, manage, and upgrade versions of rustc, cargo, clippy, rustfmt and more."
}]
},
Expand All @@ -298,6 +299,7 @@
"recommendations": [{
"name": "clippy",
"link": "https://github.com/rust-lang/rust-clippy#usage",
"docs": "https://doc.rust-lang.org/clippy/",
"notes": "The official Rust linter."
}, {
"name": "cargo-semver-checks",
Expand All @@ -310,6 +312,7 @@
"recommendations": [{
"name": "rustfmt",
"link": "https://github.com/rust-lang/rustfmt#rustfmt----",
"docs": "https://rust-lang.github.io/rustfmt/",
"notes": "The official Rust code formatter."
}]
},
Expand All @@ -318,6 +321,7 @@
"recommendations": [{
"name": "cross",
"link": "https://github.com/cross-rs/cross#cross",
"docs": "https://github.com/cross-rs/cross/wiki/Getting-Started",
"notes": "Seamless cross-compiling using Docker containers."
}, {
"name": "cargo-zigbuild",
Expand Down Expand Up @@ -346,6 +350,7 @@
}, {
"name": "cargo-deny",
"link": "https://github.com/EmbarkStudios/cargo-deny#-cargo-deny",
"docs": "https://embarkstudios.github.io/cargo-deny/",
"notes": "Enforce policies on your code and dependencies."
}]
},
Expand All @@ -359,6 +364,7 @@
{
"name": "insta",
"link": "https://insta.rs",
"docs": "https://insta.rs/docs/",
"notes": "Snapshot testing with inline snapshot support"
}]
},
Expand Down Expand Up @@ -404,10 +410,12 @@
"recommendations": [{
"name": "cargo-release",
"link": "https://github.com/crate-ci/cargo-release#cargo-release",
"docs": "https://github.com/crate-ci/cargo-release/tree/master/docs",
"notes": "Helper for publishing new crate versions."
}, {
"name": "Release-plz",
"link": "https://release-plz.ieni.dev/",
"docs": "https://release-plz.ieni.dev/docs",
"notes": "Release Rust crates from CI with a Release PR."
}]
},
Expand Down Expand Up @@ -970,6 +978,7 @@
"recommendations": [{
"name": "globset",
"link": "https://crates.io/crates/globset",
"docs": "https://docs.rs/globset",
"notes": "High-performance globbing that allows multiple globs to be evaluated at once"
}]
},
Expand All @@ -978,10 +987,12 @@
"recommendations": [{
"name": "walkdir",
"link": "https://crates.io/crates/walkdir",
"docs": "https://docs.rs/walkdir",
"notes": "Basic recursive filesystem walking."
}, {
"name": "ignore",
"link": "https://crates.io/crates/ignore",
"docs": "https://docs.rs/ignore",
"notes": "Recursive filesystem walking that respects ignore files (like .gitignore)"
}]
},
Expand Down Expand Up @@ -1018,6 +1029,7 @@
"recommendations": [{
"name": "termcolor",
"link": "https://crates.io/crates/termcolor",
"docs": "https://docs.rs/termcolor",
"notes": "Cross-platform terminal colour output"
}]
},
Expand Down Expand Up @@ -1154,20 +1166,22 @@
"notes": "Retained mode UI with a nice API. It's useable for basic apps, but has a number of missing features including multiple windows, layers, and proper text rendering."
}, {
"name": "floem",
"link": "https://github.com/lapce/floem",
"notes": "Inspired by Xilem, Leptos and rui, floem is currently more complete than any of them for native UI. Used by the Lapce text editor."
}, {
"name": "vizia",
"link": "https://github.com/vizia/vizia",
"docs": "https://book.vizia.dev/",
"notes": "Fairly complete with sophisticated layout and text layout, but has yet to make a stable release."
}],
"see_also": [{
"name": "xilem",
"link": "https://github.com/linebender/xilem",
"docs": "https://docs.rs/xilem",
"notes": "The replacement for Druid based on the more interoperable Vello and Glazier crates. However, it's currently not complete enough to be usable."
}, {
"name": "freya",
"link": "https://github.com/marc2332/freya",
"docs": "https://book.freyaui.dev/",
"notes": "Dioxus-based GUI framework using Skia for rendering."
}, {
"name": "slint",
Expand All @@ -1178,14 +1192,16 @@
}, {
"name": "gpui",
"link": "https://github.com/zed-industries/zed/tree/main/crates/gpui",
"docs": "https://www.gpui.rs/#docs",
"notes": "High performance framework used in the Zed text editor. Now available on macOS and linux."
}, {
"name": "makepad",
"link": "https://makepad.dev/",
"link": "https://github.com/makepad/makepad",
"notes": "Makepad has a strong focus on performance and minimising bloat but is consequently less feature complete in areas such as accessibility and system integration."
}, {
"name": "ribir",
"link": "https://ribir.org/"
"link": "https://ribir.org/",
"docs": "https://ribir.org/docs/introduction/"
},
{ "name": "cushy" },
{ "name": "rui" },
Expand Down Expand Up @@ -1214,7 +1230,6 @@
"notes": "Bindings to the Skia C++ library. The most complete option with excellent performance. However, it can be difficult to get it to compile."
}, {
"name": "vello",
"link": "https://github.com/linebender/vello",
"notes": "WGPU based and uses cutting edge techniques to render vector paths using the GPU. Still somewhat immature and hasn't yet put out a stable release."
}, {
"name": "vger",
Expand All @@ -1240,6 +1255,7 @@
}, {
"name": "parley",
"link": "https://github.com/dfrg/parley",
"docs": "https://docs.rs/parley/latest/parley/",
"notes": "Another very accomplished text layout library used by Druid/Xilem."
}]
}, {
Expand Down
3 changes: 2 additions & 1 deletion src/routes/crate_list.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ struct Crate {
name: String,
notes: Option<String>,
link: Option<String>,
docs: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
Expand Down Expand Up @@ -84,4 +85,4 @@ struct CrateGroup {
#[derive(Debug, Clone, Serialize, Deserialize)]
struct CrateDefinitionFile {
crate_groups: Vec<CrateGroup>,
}
}
8 changes: 4 additions & 4 deletions templates/macros/crate_table.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@

{% for crate in purpose.recommendations %}
<p style="margin: 3px 6px;max-width: 600px">
<b><a target="_blank" style="text-decoration: underline" href="{% if crate.link %}{{ crate.link }}{% else %}https://lib.rs/crates/{{ crate.name }}{% endif %}">{{ crate.name }}</a></b>{% if not crate.link %}
<a target="_blank" style="margin-left: 3px;opacity: 0.7;color: #333;" href="https://docs.rs/{{ crate.name }}"> [docs]</a>
<b><a target="_blank" style="text-decoration: underline" href="{% if crate.link %}{{ crate.link }}{% else %}https://lib.rs/crates/{{ crate.name }}{% endif %}">{{ crate.name }}</a></b>{% if crate.docs or not crate.link %}
<a target="_blank" style="margin-left: 3px;opacity: 0.7;color: #333;" href="{% if crate.docs %}{{ crate.docs }}{% else %}https://docs.rs/{{ crate.name }}{% endif %}"> [docs]</a>
{% endif %}
<br />
{% if crate.notes %}{{ crate.notes | safe }}{% endif %}
Expand All @@ -42,8 +42,8 @@
<summary style="cursor: pointer"><b><i>See also</i></b> <span style="color: #999">(click to open)</span></summary>
{% for crate in purpose.see_also %}
<p style="margin: 3px 6px;max-width: 600px">
<b><a target="_blank" style="text-decoration: underline" href="{% if crate.link %}{{ crate.link }}{% else %}https://lib.rs/{{ crate.name }}{% endif %}">{{ crate.name }}</a></b>{% if not crate.link %}
<a target="_blank" style="margin-left: 3px;opacity: 0.7;color: #333" href="https://docs.rs/{{ crate.name }}"> [docs]</a>
<b><a target="_blank" style="text-decoration: underline" href="{% if crate.link %}{{ crate.link }}{% else %}https://lib.rs/{{ crate.name }}{% endif %}">{{ crate.name }}</a></b>{% if crate.docs or not crate.link %}
<a target="_blank" style="margin-left: 3px;opacity: 0.7;color: #333" href="{% if crate.docs %}{{ crate.docs }}{% else %}https://docs.rs/{{ crate.name }}{% endif %}"> [docs]</a>
{% endif %}
<br />
{% if crate.notes %}{{ crate.notes | safe }}{% endif %}
Expand Down