[all] Remove needless anchor tags from lib.rs & README.md

Markdown automatically generates anchor tags for headings. The vscode extension `Auto Markdown TOC` is used to generate the table of contents and it was spuriously adding anchor tags to the headings. https://marketplace.visualstudio.com/items?itemName=huntertran.auto-markdown-toc This commit removes the anchor tags from the headings in the `lib.rs` and (their cargo-readme generated) `README.md` files.
r3bl-org · Sep 15, 2024 · 58388f6 · 58388f6
1 parent 578e2c1
commit 58388f6
Show file tree

Hide file tree

Showing 24 changed files with 0 additions and 208 deletions.
diff --git a/analytics_schema/README.md b/analytics_schema/README.md
@@ -71,7 +71,6 @@ niceties & ergonomics that all Rustaceans 🦀 can enjoy 🎉.
 <!-- /TOC -->
 
 ## Introduction
-<a id="markdown-introduction" name="introduction"></a>
 
 This crate is a shared dependency of a few crates in the R3BL ecosystem. It describes
 data structures that are used to represent analytics data. These data structures are
@@ -89,14 +88,12 @@ Here are some other crates for which this crate is a dependency (run `rg
 1. The analytics backend for R3BL which is closed source.
 
 ## Changelog
-<a id="markdown-changelog" name="changelog"></a>
 
 Please check out the
 [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_analytics_schema)
 to see how the library has evolved over time.
 
 ## Learn how these crates are built, provide feedback
-<a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 
 To learn how we built this crate, please take a look at the following resources.
 - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).

diff --git a/analytics_schema/src/lib.rs b/analytics_schema/src/lib.rs
@@ -86,7 +86,6 @@
 //! <!-- /TOC -->
 //!
 //! # Introduction
-//! <a id="markdown-introduction" name="introduction"></a>
 //!
 //! This crate is a shared dependency of a few crates in the R3BL ecosystem. It describes
 //! data structures that are used to represent analytics data. These data structures are
@@ -104,14 +103,12 @@
 //! 1. The analytics backend for R3BL which is closed source.
 //!
 //! # Changelog
-//! <a id="markdown-changelog" name="changelog"></a>
 //!
 //! Please check out the
 //! [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_analytics_schema)
 //! to see how the library has evolved over time.
 //!
 //! # Learn how these crates are built, provide feedback
-//! <a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 //!
 //! To learn how we built this crate, please take a look at the following resources.
 //! - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).

diff --git a/ansi_color/README.md b/ansi_color/README.md
@@ -77,7 +77,6 @@ niceties & ergonomics that all Rustaceans 🦀 can enjoy 🎉.
 <!-- /TOC -->
 
 ## Introduction
-<a id="markdown-introduction" name="introduction"></a>
 
 Rust crate to generate formatted ANSI 256 (8-bit) and truecolor (24-bit) color output to stdout. On
 macOS, the default Terminal.app does not support truecolor, so ANSI 256 colors are used instead.
@@ -104,22 +103,19 @@ Here's a screenshot of running the `main` example on various operating systems:
 | *Running on macOS iTerm app (note Truecolor runtime detection)* |
 
 ## Changelog
-<a id="markdown-changelog" name="changelog"></a>
 
 Please check out the
 [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_ansi_color)
 to see how the library has evolved over time.
 
 ## Learn how these crates are built, provide feedback
-<a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 
 To learn how we built this crate, please take a look at the following resources.
 - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).
 - If you like consuming written content, here's our developer [site](https://developerlife.com/). Please consider subscribing to our [newsletter](https://developerlife.com/subscribe.html).
 - If you have questions, please join our [discord server](https://discord.gg/8M2ePAevaM).
 
 ## How to use it
-<a id="markdown-how-to-use-it" name="how-to-use-it"></a>
 
 The main struct that we have to consider is `AnsiStyledText`. It has two fields:
 
@@ -149,10 +145,8 @@ Please a look at the
 better idea of how to use this crate.
 
 ## Build, run, test tasks
-<a id="markdown-build-run-test-tasks" name="build-run-test-tasks"></a>
 
 ### Prerequisites
-<a id="markdown-prerequisites" name="prerequisites"></a>
 
 🌠 In order for these to work you have to install the Rust toolchain and `nu` and
 `cargo-watch`:
@@ -165,7 +159,6 @@ better idea of how to use this crate.
    is available for Linux, macOS, and Windows. And it is written in Rust.
 
 ### Nushell commands
-<a id="markdown-nushell-commands" name="nushell-commands"></a>
 
 | Command                                 | Description                                                                                         |
 |-----------------------------------------|-----------------------------------------------------------------------------------------------------|
@@ -192,7 +185,6 @@ The following commands will watch for changes in the source folder and re-run:
 | `nu run watch-macro-expansion-one-test <test_name>` | Watch macro expansion for one test                                                                  |
 
 ## References
-<a id="markdown-references" name="references"></a>
 
 - [ANSI Escape Codes](https://notes.burke.libbey.me/ansi-escape-codes/)
 - [ASCII Table](https://www.asciitable.com/)
@@ -202,7 +194,6 @@ The following commands will watch for changes in the source folder and re-run:
 - [Color Metric](https://www.compuphase.com/cmetric.htm)
 
 ## Why make a new crate for this?
-<a id="markdown-why-make-a-new-crate-for-this" name="why-make-a-new-crate-for-this"></a>
 
 - There are a few crates on crates.io that do similar things but they don't amenable
   licenses.

diff --git a/ansi_color/src/lib.rs b/ansi_color/src/lib.rs
@@ -92,7 +92,6 @@
 //! <!-- /TOC -->
 //!
 //! # Introduction
-//! <a id="markdown-introduction" name="introduction"></a>
 //!
 //! Rust crate to generate formatted ANSI 256 (8-bit) and truecolor (24-bit) color output to stdout. On
 //! macOS, the default Terminal.app does not support truecolor, so ANSI 256 colors are used instead.
@@ -119,22 +118,19 @@
 //! | *Running on macOS iTerm app (note Truecolor runtime detection)* |
 //!
 //! # Changelog
-//! <a id="markdown-changelog" name="changelog"></a>
 //!
 //! Please check out the
 //! [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_ansi_color)
 //! to see how the library has evolved over time.
 //!
 //! # Learn how these crates are built, provide feedback
-//! <a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 //!
 //! To learn how we built this crate, please take a look at the following resources.
 //! - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).
 //! - If you like consuming written content, here's our developer [site](https://developerlife.com/). Please consider subscribing to our [newsletter](https://developerlife.com/subscribe.html).
 //! - If you have questions, please join our [discord server](https://discord.gg/8M2ePAevaM).
 //!
 //! # How to use it
-//! <a id="markdown-how-to-use-it" name="how-to-use-it"></a>
 //!
 //! The main struct that we have to consider is `AnsiStyledText`. It has two fields:
 //!
@@ -164,10 +160,8 @@
 //! better idea of how to use this crate.
 //!
 //! # Build, run, test tasks
-//! <a id="markdown-build-run-test-tasks" name="build-run-test-tasks"></a>
 //!
 //! ## Prerequisites
-//! <a id="markdown-prerequisites" name="prerequisites"></a>
 //!
 //! 🌠 In order for these to work you have to install the Rust toolchain and `nu` and
 //! `cargo-watch`:
@@ -180,7 +174,6 @@
 //!    is available for Linux, macOS, and Windows. And it is written in Rust.
 //!
 //! ## Nushell commands
-//! <a id="markdown-nushell-commands" name="nushell-commands"></a>
 //!
 //! | Command                                 | Description                                                                                         |
 //! |-----------------------------------------|-----------------------------------------------------------------------------------------------------|
@@ -207,7 +200,6 @@
 //! | `nu run watch-macro-expansion-one-test <test_name>` | Watch macro expansion for one test                                                                  |
 //!
 //! # References
-//! <a id="markdown-references" name="references"></a>
 //!
 //! - [ANSI Escape Codes](https://notes.burke.libbey.me/ansi-escape-codes/)
 //! - [ASCII Table](https://www.asciitable.com/)
@@ -217,7 +209,6 @@
 //! - [Color Metric](https://www.compuphase.com/cmetric.htm)
 //!
 //! # Why make a new crate for this?
-//! <a id="markdown-why-make-a-new-crate-for-this" name="why-make-a-new-crate-for-this"></a>
 //!
 //! - There are a few crates on crates.io that do similar things but they don't amenable
 //!   licenses.

diff --git a/cmdr/README.md b/cmdr/README.md
@@ -76,7 +76,6 @@ niceties & ergonomics that all Rustaceans 🦀 can enjoy 🎉.
 <!-- /TOC -->
 
 ## Installation
-<a id="markdown-installation" name="installation"></a>
 
 The two apps, `edi` and `giti`, that comprise `r3bl-cmdr` will put a smile on your face and
 make you more productive. These apps are currently available as early access preview 🐣.
@@ -102,22 +101,19 @@ If you don't have `cargo` on your system, you can either:
    r3bl-open-core/cmdr && cargo install`.
 
 ## Changelog
-<a id="markdown-changelog" name="changelog"></a>
 
 Please check out the
 [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl-cmdr) to
 see how the library has evolved over time.
 
 ## Learn how these crates are built, provide feedback
-<a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 
 To learn how we built this crate, please take a look at the following resources.
 - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).
 - If you like consuming written content, here's our developer [site](https://developerlife.com/). Please consider subscribing to our [newsletter](https://developerlife.com/subscribe.html).
 - If you have questions, please join our [discord server](https://discord.gg/8M2ePAevaM).
 
 ## Run `giti` binary target
-<a id="markdown-run-giti-binary-target" name="run-giti-binary-target"></a>
 
 <!--
 giti branch video
@@ -148,7 +144,6 @@ To run from source:
   `giti -l branch delete`. To view this log output run `nu run log`.
 
 ## Run `edi` binary target
-<a id="markdown-run-edi-binary-target" name="run-edi-binary-target"></a>
 
 <!--
 edi video
@@ -175,11 +170,8 @@ To run from source:
   `edi -l README.md`. To view this log output run `nu run log`.
 
 ## Build, run, test tasks
-<a id="markdown-build%2C-run%2C-test-tasks" name="build%2C-run%2C-test-tasks"></a>
 
 ### Prerequisites
-<a id="markdown-prerequisites" name="prerequisites"></a>
-
 
 🌠 In order for these to work you have to install the Rust toolchain, `nu`, `cargo-watch`, `bat`,
 and `flamegraph` on your system. Here are the instructions:
@@ -193,7 +185,6 @@ and `flamegraph` on your system. Here are the instructions:
    available for Linux, macOS, and Windows.
 
 ### Nushell scripts to build, run, test etc.
-<a id="markdown-nushell-scripts-to-build-run-test-etc" name="nushell-scripts-to-build-run-test-etc"></a>
 
 | Command             | Description                                                                                                          |
 | ------------------- | -------------------------------------------------------------------------------------------------------------------- |

diff --git a/cmdr/src/lib.rs b/cmdr/src/lib.rs
@@ -91,7 +91,6 @@
 //! <!-- /TOC -->
 //!
 //! # Installation
-//! <a id="markdown-installation" name="installation"></a>
 //!
 //! The two apps, `edi` and `giti`, that comprise `r3bl-cmdr` will put a smile on your face and
 //! make you more productive. These apps are currently available as early access preview 🐣.
@@ -117,22 +116,19 @@
 //!    r3bl-open-core/cmdr && cargo install`.
 //!
 //! # Changelog
-//! <a id="markdown-changelog" name="changelog"></a>
 //!
 //! Please check out the
 //! [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl-cmdr) to
 //! see how the library has evolved over time.
 //!
 //! # Learn how these crates are built, provide feedback
-//! <a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 //!
 //! To learn how we built this crate, please take a look at the following resources.
 //! - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).
 //! - If you like consuming written content, here's our developer [site](https://developerlife.com/). Please consider subscribing to our [newsletter](https://developerlife.com/subscribe.html).
 //! - If you have questions, please join our [discord server](https://discord.gg/8M2ePAevaM).
 //!
 //! # Run `giti` binary target
-//! <a id="markdown-run-giti-binary-target" name="run-giti-binary-target"></a>
 //!
 //! <!--
 //! giti branch video
@@ -163,7 +159,6 @@
 //!   `giti -l branch delete`. To view this log output run `nu run log`.
 //!
 //! # Run `edi` binary target
-//! <a id="markdown-run-edi-binary-target" name="run-edi-binary-target"></a>
 //!
 //! <!--
 //! edi video
@@ -190,11 +185,8 @@
 //!   `edi -l README.md`. To view this log output run `nu run log`.
 //!
 //! # Build, run, test tasks
-//! <a id="markdown-build%2C-run%2C-test-tasks" name="build%2C-run%2C-test-tasks"></a>
 //!
 //! ## Prerequisites
-//! <a id="markdown-prerequisites" name="prerequisites"></a>
-//!
 //!
 //! 🌠 In order for these to work you have to install the Rust toolchain, `nu`, `cargo-watch`, `bat`,
 //! and `flamegraph` on your system. Here are the instructions:
@@ -208,7 +200,6 @@
 //!    available for Linux, macOS, and Windows.
 //!
 //! ## Nushell scripts to build, run, test etc.
-//! <a id="markdown-nushell-scripts-to-build-run-test-etc" name="nushell-scripts-to-build-run-test-etc"></a>
 //!
 //! | Command             | Description                                                                                                          |
 //! | ------------------- | -------------------------------------------------------------------------------------------------------------------- |

diff --git a/core/README.md b/core/README.md
@@ -70,7 +70,6 @@ niceties & ergonomics that all Rustaceans 🦀 can enjoy 🎉.
 <!-- /TOC -->
 
 ## Introduction
-<a id="markdown-introduction" name="introduction"></a>
 
 This crate provides lots of low level functionality like Unicode strings (that support
 emoji), text styling, and more.
@@ -100,14 +99,12 @@ more info on this
 [here](https://doc.rust-lang.org/book/ch07-04-bringing-paths-into-scope-with-the-use-keyword.html?highlight=module%20re-export#re-exporting-names-with-pub-use).
 
 ## Changelog
-<a id="markdown-changelog" name="changelog"></a>
 
 Please check out the
 [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_rs_utils_core)
 to see how the library has evolved over time.
 
 ## Learn how these crates are built, provide feedback
-<a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 
 To learn how we built this crate, please take a look at the following resources.
 - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).

diff --git a/core/src/lib.rs b/core/src/lib.rs
@@ -85,7 +85,6 @@
 //! <!-- /TOC -->
 //!
 //! # Introduction
-//! <a id="markdown-introduction" name="introduction"></a>
 //!
 //! This crate provides lots of low level functionality like Unicode strings (that support
 //! emoji), text styling, and more.
@@ -115,14 +114,12 @@
 //! [here](https://doc.rust-lang.org/book/ch07-04-bringing-paths-into-scope-with-the-use-keyword.html?highlight=module%20re-export#re-exporting-names-with-pub-use).
 //!
 //! # Changelog
-//! <a id="markdown-changelog" name="changelog"></a>
 //!
 //! Please check out the
 //! [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_rs_utils_core)
 //! to see how the library has evolved over time.
 //!
 //! # Learn how these crates are built, provide feedback
-//! <a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 //!
 //! To learn how we built this crate, please take a look at the following resources.
 //! - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).

diff --git a/macro/README.md b/macro/README.md
@@ -71,7 +71,6 @@ niceties & ergonomics that all Rustaceans 🦀 can enjoy 🎉.
 <!-- /TOC -->
 
 ## Introduction
-<a id="markdown-introduction" name="introduction"></a>
 
 This crate is necessary since Rust requires procedural macros to be in their own
 crate, and this crate provides all the procedural macros for the
@@ -93,14 +92,12 @@ macros](https://developerlife.com/2022/03/30/rust-proc-macro/) on
 [developerlife.com](https://developerlife.com/category/Rust/).
 
 ## Changelog
-<a id="markdown-changelog" name="changelog"></a>
 
 Please check out the
 [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_rs_utils_macro)
 to see how the library has evolved over time.
 
 ## Learn how these crates are built, provide feedback
-<a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 
 To learn how we built this crate, please take a look at the following resources.
 - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).

diff --git a/macro/src/lib.rs b/macro/src/lib.rs
@@ -86,7 +86,6 @@
 //! <!-- /TOC -->
 //!
 //! # Introduction
-//! <a id="markdown-introduction" name="introduction"></a>
 //!
 //! This crate is necessary since Rust requires procedural macros to be in their own
 //! crate, and this crate provides all the procedural macros for the
@@ -108,14 +107,12 @@
 //! [developerlife.com](https://developerlife.com/category/Rust/).
 //!
 //! # Changelog
-//! <a id="markdown-changelog" name="changelog"></a>
 //!
 //! Please check out the
 //! [changelog](https://github.com/r3bl-org/r3bl-open-core/blob/main/CHANGELOG.md#r3bl_rs_utils_macro)
 //! to see how the library has evolved over time.
 //!
 //! # Learn how these crates are built, provide feedback
-//! <a id="markdown-learn-how-these-crates-are-built-provide-feedback" name="learn-how-these-crates-are-built-provide-feedback"></a>
 //!
 //! To learn how we built this crate, please take a look at the following resources.
 //! - If you like consuming video content, here's our [YT channel](https://www.youtube.com/@developerlifecom). Please consider [subscribing](https://www.youtube.com/channel/CHANNEL_ID?sub_confirmation=1).