docs(examples): move hyperlink example to examples folder (#1650)

Cargo.lock

@@ -1354,6 +1354,16 @@ dependencies = [
  "tracing",
 ]
 
+[[package]]
+name = "hyperlink"
+version = "0.0.0"
+dependencies = [
+ "color-eyre",
+ "crossterm",
+ "itertools 0.13.0",
+ "ratatui",
+]
+
 [[package]]
 name = "iana-time-zone"
 version = "0.1.61"

examples/README.md

@@ -77,6 +77,10 @@ This example shows different types of constraints. [Source](./apps/constraints/)
 
 This example shows how to create a custom widget that can be interacted with the mouse. [Source](./apps/custom-widget/).
 
+## Hyperlink demo
+
+Shows how to render hyperlinks in a terminal using [OSC 8](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda). [Source](./apps/hyperlink/).
+
 ## Flex demo
 
 This interactive example shows how to use the flex layouts. [Source](./apps/flex/).

examples/apps/hyperlink/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "hyperlink"
+publish = false
+license.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+
+[dependencies]
+color-eyre.workspace = true
+crossterm.workspace = true
+itertools.workspace = true
+ratatui.workspace = true
+
+[lints]
+workspace = true

examples/apps/hyperlink/README.md

@@ -0,0 +1,9 @@
+# Hyperlink demo
+
+This example shows how to render hyperlinks in a terminal using [OSC 8](https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda).
+
+To run this demo:
+
+```shell
+cargo run -p hyperlink
+```

examples/apps/hyperlink/src/main.rs

@@ -1,21 +1,11 @@
-//! # [Ratatui] Hyperlink examplew
-//!
-//! Shows how to use [OSC 8] to create hyperlinks in the terminal.
-//!
-//! The latest version of this example is available in the [examples] folder in the repository.
-//!
-//! Please note that the examples are designed to be run against the `main` branch of the Github
-//! repository. This means that you may not be able to compile with the latest release version on
-//! crates.io, or the one that you have installed locally.
-//!
-//! See the [examples readme] for more information on finding examples that match the version of the
-//! library you are using.
-//!
-//! [OSC 8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
-//! [Ratatui]: https://github.com/ratatui/ratatui
-//! [examples]: https://github.com/ratatui/ratatui/blob/main/examples
-//! [examples readme]: https://github.com/ratatui/ratatui/blob/main/examples/README.md
-
+/// A Ratatui example that how to create hyperlinks in the terminal using [OSC 8].
+///
+/// This example runs with the Ratatui library code in the branch that you are currently
+/// reading. See the [`latest`] branch for the code which works with the most recent Ratatui
+/// release.
+///
+/// [`latest`]: https://github.com/ratatui/ratatui/tree/latest
+/// [OSC 8]: https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
 use color_eyre::Result;
 use itertools::Itertools;
 use ratatui::{

ratatui/Cargo.toml

@@ -146,11 +146,6 @@ name = "inline"
 required-features = ["crossterm"]
 doc-scrape-examples = true
 
-[[example]]
-name = "hyperlink"
-required-features = ["crossterm"]
-doc-scrape-examples = true
-
 [[example]]
 name = "list-widget"
 required-features = ["crossterm"]