diff --git a/README.md b/README.md index 1c2f17a..0130107 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ The main goal of this project is to provide a usable build environment for IoT d the project focuses on developing working Arduino-compatible cores for supported families. The cores are inspired by Espressif's official core for ESP32, which should make it easier to port/run existing ESP apps on Tuya IoT (and 3-rd party) modules. -LibreTuya also provides a common interface for all family implementations. The interface is based on ESP32 official libraries. +**There's an [ESPHome port](https://docs.libretuya.ml/docs/projects/esphome/) based on LibreTuya, which supports BK7231 and RTL8710B chips.** **Note:** this project is work-in-progress. @@ -31,11 +31,7 @@ LibreTuya also provides a common interface for all family implementations. The i 1. [Install PlatformIO](https://platformio.org/platformio-ide) 2. `platformio platform install https://github.com/kuba2k2/libretuya` 3. Create a project, build it and upload! -4. See the [docs](https://kuba2k2.github.io/libretuya/) for any questions/problems. - -## Board List - -See [Boards & CPU list](https://kuba2k2.github.io/libretuya/docs/status/supported/). +4. See the [docs](https://docs.libretuya.ml/) for any questions/problems. ## Arduino Core support status diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 0000000..fddc2c6 --- /dev/null +++ b/docs/style.css @@ -0,0 +1,20 @@ +/* from https://christianoliff.com/blog/styling-external-links-with-an-icon-in-css/ */ +article a[href^="http"]::after, +article a[href^="https://"]::after { + content: ""; + width: 14px; + height: 14px; + margin-left: 4px; + background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'%3E%3Cpath d='M14 3v2h3.59l-9.83 9.83 1.41 1.41L19 6.41V10h2V3m-2 16H5V5h7V3H5a2 2 0 0 0-2 2v14a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7h-2v7Z'%3E%3C/path%3E%3C/svg%3E"); + background-position: center; + background-repeat: no-repeat; + background-size: contain; + display: inline-block; +} + +a[href^="https://docs.libretuya.ml"]::after, +a[href^="http://localhost"]::after, +a[href^="https://"].md-button::after, +div[align="center"] a[href^="https://"]::after { + display: none !important; +} diff --git a/mkdocs.yml b/mkdocs.yml index 0b37bd0..2c7b47c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -38,6 +38,9 @@ plugins: exclude: - ltapi/* +extra_css: + - docs/style.css + markdown_extensions: - md_in_html - admonition