dioxus-docs-kit 0.7.0

Reusable documentation site shell for Dioxus applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

[package]
name = "dioxus-docs-kit"
version.workspace = true
authors.workspace = true
edition.workspace = true
rust-version.workspace = true
license.workspace = true
repository.workspace = true
homepage.workspace = true
description = "Reusable documentation site shell for Dioxus applications"
documentation = "https://docs.rs/dioxus-docs-kit"
keywords = ["dioxus", "documentation", "mdx", "docs-site", "openapi"]
categories = ["web-programming", "gui"]
readme = "README.md"

[dependencies]
dioxus = { workspace = true, features = ["lib", "router"] }
dioxus-free-icons = { workspace = true }
dioxus-mdx = { workspace = true }
dioxus-code = { workspace = true, optional = true }
dioxus-fullstack-core = { version = "0.7.10", optional = true }
serde = { workspace = true }
serde_json = { workspace = true }
tracing = { workspace = true }

[target.'cfg(target_arch = "wasm32")'.dependencies]
gloo-timers = { workspace = true }

[features]
default = [
    "web",
    "mermaid",
    "highlight",
    "openapi",
    "lang-bash",
    "lang-css",
    "lang-dockerfile",
    "lang-html",
    "lang-javascript",
    "lang-json",
    "lang-markdown",
    "lang-python",
    "lang-toml",
    "lang-typescript",
    "lang-yaml",
]
web = ["dioxus/web", "dioxus-mdx/web"]
server = ["dioxus/server", "dep:dioxus-fullstack-core"]
mermaid = ["dioxus-mdx/mermaid"]
highlight = ["dep:dioxus-code", "dioxus-mdx/highlight"]
openapi = ["dioxus-mdx/openapi"]

# Syntax-highlighting grammars, one tree-sitter parser each. `highlight` on its
# own compiles no grammar beyond Rust, which ships with `dioxus-code`'s
# `runtime` (hence `lang-rust` needs nothing extra). Enable only the languages
# your fences actually use: dropping just the C# and C++ grammars took this
# repo's release wasm from 19.0 MB to 9.9 MB. A fence whose grammar is not
# compiled in renders as plain text.
#
# For a language not listed here, depend on `dioxus-code` directly with its
# `lang-*` flag; cargo unifies the feature into this crate's copy of the
# dependency and `Language::from_slug` picks the grammar up:
#   dioxus-code = { version = "0.1", default-features = false, features = [
#       "runtime", "lang-go",
#   ] }
lang-rust = ["highlight", "dioxus-mdx/lang-rust"]
lang-bash = ["highlight", "dioxus-mdx/lang-bash"]
lang-c-sharp = ["highlight", "dioxus-mdx/lang-c-sharp"]
lang-cpp = ["highlight", "dioxus-mdx/lang-cpp"]
lang-css = ["highlight", "dioxus-mdx/lang-css"]
lang-dockerfile = ["highlight", "dioxus-mdx/lang-dockerfile"]
lang-html = ["highlight", "dioxus-mdx/lang-html"]
lang-javascript = ["highlight", "dioxus-mdx/lang-javascript"]
lang-json = ["highlight", "dioxus-mdx/lang-json"]
lang-markdown = ["highlight", "dioxus-mdx/lang-markdown"]
lang-python = ["highlight", "dioxus-mdx/lang-python"]
lang-toml = ["highlight", "dioxus-mdx/lang-toml"]
lang-tsx = ["highlight", "dioxus-mdx/lang-tsx"]
lang-typescript = ["highlight", "dioxus-mdx/lang-typescript"]
lang-yaml = ["highlight", "dioxus-mdx/lang-yaml"]

[package.metadata.docs.rs]
# Without `server` the `SeoRouter` module is absent from docs.rs - it 404'd on
# 0.5.0. Deliberately not `all-features`: that would compile every `lang-*`
# tree-sitter grammar just to render the docs.
features = ["server"]