update some out of date docs

Author: ealmloff

README.md

@@ -21,8 +21,8 @@ A small Dioxus component for rendering source code with proper highlighting. Par
 
 Two ways to highlight:
 
-- **[`code!`] macro** — parses at compile time. The runtime ships only the spans, no parser. Default.
-- **[`SourceCode`]** — parses at runtime. Opt in with the `runtime` feature when the source isn't known until the user types it.
+- **[`code!`] macro** — parses at compile time and embeds the highlighted spans. Default.
+- **[`SourceCode`]** — parses at runtime. Opt in with the `runtime` feature for dynamic source text.
 
 ## Quick start
 
@@ -51,7 +51,7 @@ When the file extension is ambiguous, pass [`CodeOptions::builder`] with [`CodeO
 
 ## Runtime highlighting
 
-For editor-style use cases where the source isn't known at compile time:
+For editor-style use cases with dynamic source text:
 
 ```toml
 [dependencies]
@@ -60,24 +60,23 @@ dioxus-code = { version = "0.1", features = ["runtime"] }
 
 ```rust
 # use dioxus::prelude::*;
-use dioxus_code::{Code, CodeOptions, Language, SourceCode, Theme};
+use dioxus_code::{Code, Language, SourceCode, Theme};
 # let user_input = String::new();
 # let _ =
 rsx! {
     Code {
-        src: SourceCode::new(user_input)
-            .with_options(CodeOptions::builder().with_language(Language::Rust)),
+        src: SourceCode::new(Language::Rust, user_input),
         theme: Theme::GITHUB_LIGHT,
     }
 }
 # ;
 ```
 
-Language must be set explicitly with the same [`CodeOptions`] builder used by [`code!`]. The default `runtime` feature includes Rust; pass `lang-python`, `lang-toml`, or `all-languages` for the rest.
+Pass a [`Language`] variant when building [`SourceCode`]. The `runtime` feature includes Rust; enable the matching `lang-*` feature, or `all-languages`, for additional grammars.
 
 ## Editor
 
-[`dioxus-code-editor`] is a sibling crate that pairs the highlighter with a `contenteditable` input layer:
+[`dioxus-code-editor`] is a sibling crate that pairs the highlighter with a textarea input layer:
 
 ```rust
 # use dioxus::prelude::*;
@@ -131,7 +130,7 @@ Code {
 
 ```sh
 dx serve --example dioxus-code-basic       # macro + runtime side by side
-dx serve --example dioxus-code-macro-only  # compile-time only, no parser in the binary
+dx serve --example dioxus-code-macro-only  # compile-time highlighted spans
 dx serve --example dioxus-code-live-input  # textarea bound to runtime highlighter
 ```
 

code-editor/README.md

@@ -23,7 +23,7 @@ A controlled, syntax-highlighted code editor for Dioxus. Pairs an editable input
 
 ```toml
 [dependencies]
-dioxus-code-editor = 0.1.0"
+dioxus-code-editor = "0.1.0"
 ```
 
 ```rust
@@ -53,7 +53,7 @@ The component is controlled — drive [`CodeEditorProps::value`] from your own s
 | prop | description |
 |---|---|
 | [`CodeEditorProps::value`] | Current editor contents. |
-| [`CodeEditorProps::language`] | Tree-sitter grammar selection. Pass a [`Language`] variant (for example [`Language::Rust`]) or use [`Language::from_slug`] for custom slugs. |
+| [`CodeEditorProps::language`] | Syntax grammar selection. Pass a [`Language`] variant (for example [`Language::Rust`]) or use [`Language::from_slug`] for runtime slugs. |
 | [`CodeEditorProps::theme`] | Syntax theme selection shared with [`dioxus-code`](https://crates.io/crates/dioxus-code); accepts [`Theme`] or [`CodeTheme`]. |
 | [`CodeEditorProps::line_numbers`] | Show a one-based line gutter. Defaults to `true`. |
 | [`CodeEditorProps::read_only`] | Disable editing while preserving highlighting. |

dioxus-code-macro/README.md

@@ -19,7 +19,7 @@
 
 Implementation crate for the [`code!`] macro re-exported by [`dioxus-code`](https://crates.io/crates/dioxus-code) under its default `macro` feature. You usually depend on `dioxus-code` instead of pulling this in directly.
 
-The macro reads a source file at compile time, parses it with [`arborium`](https://crates.io/crates/arborium), and expands to a static span tree. The runtime binary ships only the spans — no parser.
+The macro reads a source file at compile time, parses it with [`arborium`](https://crates.io/crates/arborium), and expands to a static span tree that can be rendered by `dioxus-code`.
 
 ```rust
 use dioxus_code::code;

docsite/src/main.rs

@@ -530,7 +530,7 @@ fn Hero(theme: CodeTheme, theme_label: String) -> Element {
                         "."
                     }
                     p { class: "hero-lede",
-                        "A drop-in component with two source modes — compile-time macro and runtime detection. No JS, no flash of unstyled code."
+                        "A drop-in component with two source modes: compile-time macro and runtime highlighting with explicit language selection."
                     }
                     div { class: "hero-terminal-block",
                         div { class: "hero-terminal-bar",
@@ -626,30 +626,30 @@ fn FeatureRowReceipt() -> Element {
                             span { class: "receipt-value", "OPT-IN" }
                         }
                         li { class: "receipt-item receipt-optional",
-                            span { class: "receipt-label", "Tree-sitter grammars" }
+                            span { class: "receipt-label", "Runtime grammars" }
                             span { class: "receipt-dots" }
                             span { class: "receipt-value", "+3.33 MiB" }
                         }
                     }
                     div { class: "receipt-rule double" }
                     div { class: "receipt-total",
-                        span { class: "receipt-total-label", "PARSER BYTES SHIPPED" }
-                        span { class: "receipt-total-value", "0" }
+                        span { class: "receipt-total-label", "COMPILE-TIME MODE" }
+                        span { class: "receipt-total-value", "STATIC" }
                     }
                 }
                 aside { class: "receipt-aside",
                     div { class: "receipt-aside-row",
                         span { class: "receipt-aside-num", "01" }
                         div {
                             h3 { class: "receipt-aside-title", "code!" }
-                            p { class: "receipt-aside-text", "Tokenizes during cargo build. The runtime gets pre-styled markup with no parser bytes." }
+                            p { class: "receipt-aside-text", "Tokenizes during cargo build and embeds highlighted spans for rendering." }
                         }
                     }
                     div { class: "receipt-aside-row",
                         span { class: "receipt-aside-num", "02" }
                         div {
                             h3 { class: "receipt-aside-title", "SourceCode" }
-                            p { class: "receipt-aside-text", "Pull it in when input is dynamic. Tree-sitter grammars detect language automatically." }
+                            p { class: "receipt-aside-text", "Pull it in when input is dynamic and pass the language your source uses." }
                         }
                     }
                     div { class: "receipt-aside-row",

src/advanced.rs

@@ -784,11 +784,7 @@ impl Buffer {
     /// Useful for handing off to [`Code()`](crate::Code()) or any consumer
     /// that takes the frozen snapshot type.
     pub fn highlighted(&self) -> HighlightedSource {
-        HighlightedSource::from_owned_parts(
-            self.source.clone(),
-            self.language,
-            self.spans.clone(),
-        )
+        HighlightedSource::from_owned_parts(self.source.clone(), self.language, self.spans.clone())
     }
 
     fn parser_for(
@@ -1381,8 +1377,8 @@ fn grammar_for(language: Language) -> (arborium_tree_sitter::LanguageFn, &'stati
 
 /// A byte-range edit description used to drive incremental highlighting.
 ///
-/// Build one from a real edit signal (for example a contenteditable
-/// `beforeinput` event) and pass it to [`Buffer::edit`]. `start_byte` and
+/// Build one from a real edit signal (for example a textarea `beforeinput`
+/// event) and pass it to [`Buffer::edit`]. `start_byte` and
 /// `old_end_byte` index into the buffer's previous source, while
 /// `new_end_byte` indexes into the new source supplied alongside the edit.
 ///

src/language.rs

@@ -2,8 +2,7 @@
 //!
 //! [`Language`] is a closed set of Arborium language slugs. Each named variant
 //! is gated by the same cargo feature as the corresponding grammar in
-//! `dioxus-code`, so the enum only ever exposes variants whose grammar is
-//! actually compiled into this build.
+//! `dioxus-code`, so the enum exposes the variants compiled into this build.
 
 macro_rules! define_languages {
     (
@@ -16,8 +15,8 @@ macro_rules! define_languages {
         ///
         /// Each variant maps to an Arborium language slug via
         /// [`Language::slug`]. Variants are gated by the same `lang-*` cargo
-        /// features as the grammar lookup table, so unsupported builds simply
-        /// don't expose those variants.
+        /// features as the grammar lookup table, so each build exposes the
+        /// variants enabled for that build.
         ///
         /// ```rust
         /// use dioxus_code::Language;