diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e25906b..964b8e4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -8,16 +8,16 @@ on: - "user_guide/**" jobs: update: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Set up Python 3.10 - uses: actions/setup-python@v2 + - uses: actions/checkout@v4 + - name: Set up Python 3.12 + uses: actions/setup-python@v5 with: - python-version: "3.10" + python-version: "3.12" - name: Install dependencies run: | - python -m pip install -r user_guide/requirements.txt + python3.12 -m pip install -r user_guide/requirements.txt - name: MkDocs publish run: mkdocs gh-deploy --force working-directory: user_guide diff --git a/user_guide/docs/build.md b/user_guide/docs/build.md index 1da1c98..5ac5a5c 100644 --- a/user_guide/docs/build.md +++ b/user_guide/docs/build.md @@ -2,7 +2,7 @@ title: Kit build guide --- -# Speak to Me kit build guide +# Build Welcome to the build guide for Speak to Me's DIY kit. We hope you have a great time putting this module together and a wonderful time using it. @@ -15,61 +15,52 @@ This build takes around **two hours** to complete. [discord]: https://discord.gg/UpfqghQ -## Tools and materials required +## Tools required -Before jumping in, make sure you have: +Before you begin, make sure that you've got: -* Safety glasses. Yes, really. -* Proper ventilation- at least open a window or two. -* A soldering iron, like [this one](https://www.adafruit.com/product/180). -* Solder, we can recommend [Adafruit's 60/40 **no-clean** rosin core solder](https://www.adafruit.com/product/145). We suggest using soldering with "no clean" flux. If you do use a different kind of flux, be sure to carefully clean the flux residue off based on the guidelines provided by the manufacturer of your solder. +- Safety glasses. Yes, **really**. A pair like [these][safety glasses] are fine. +- Proper ventilation, like this [small filtered fan](https://a.co/d/eUfPCRO). +- A **temperature-controlled** soldering iron, like this [Hakko] or the [Pinecil]. It is very important to use a temperature-controlled iron, since unregulated irons can easily get hot enough to damage components. You should set your iron temperature based on your solder manufacturer's recommendations. +- Solder. We recommend [Adafruit's SAC305 solder][adafruit solder] or [Kester 275 K100LD]. + +!!! question "Flux" + We suggest using solder with "no clean" flux. If you use a different kind of flux, be sure to carefully clean the flux residue off based on the guidelines provided by the manufacturer of your solder. Take special care with the LEDs and potentiometers, as they can be damaged by water and flux cleaners. + +[safety glasses]: https://a.co/d/dMXvPP6 +[tweezers]: https://www.adafruit.com/product/422 +[Hakko]: https://www.adafruit.com/product/1204 +[Pinecil]: https://pine64.com/product/pinecil-smart-mini-portable-soldering-iron/ +[adafruit solder]: https://www.adafruit.com/product/734 +[Kester 275 K100LD]: https://www.kester.com/products/product/275-flux-cored-wire +[flux pen]: https://www.sra-solder.com/sra-312-no-clean-flux-pen-refillable ## Kit contents Your kit should contain the following items. If any are missing please email us at support@winterbloom.com. - - - - - - - - - - - - - - - - - - - - - - - - - - - + + Mainboard + Front panel + 1/8" jacks (2) + Hex nuts for the 1/8" jacks (2) + Eurorack power header + Rubber band + JST wiring harness + 2.5mm L wrench + 2mm L wrench + M3x12 black hex bolts (4) + M3 nuts (4) + JST XH-2 header + Stereo potentiometer + Flat flex cable + Speaker + Grille cloth + 1/4 stereo jack + Speaker spacer + Knob + Headphone jack breakout board + - (1) Mainboard @@ -137,9 +128,11 @@ Since the potentiometer and jacks need to peek through the front panel, you can Use the rubber band to temporarily hold the front panel on while you're working on it. You'll need to double- or triple- over the rubber band to get it tight. -![A rubber band being pulled taught across the center of the module](/images/11-rubber-band-4.jpg) -![The module with a doubled-overed rubber band holding the panel in place](/images/11-rubber-band-3.jpg) -![The same but showing the back side of the module](/images/11-rubber-band-2.jpg) + + ![A rubber band being pulled taught across the center of the module](/images/11-rubber-band-4.jpg) + ![The module with a doubled-overed rubber band holding the panel in place](/images/11-rubber-band-3.jpg) + ![The same but showing the back side of the module](/images/11-rubber-band-2.jpg) + ## Soldering the front side components @@ -170,8 +163,10 @@ Next up is soldering the flat flex cable to the mainboard. Prepare the flat flex cable by removing the cover on one side of it. Just pull up lightly to get the cover to come off- **do not cut the flat flex cable**. -![The flat flex cable with the small cover on the top of it being held lightly](/images/16-ffc-prep-3.jpg) -![The flat flex cable with the small cover on the top removed, revealing the conductors](/images/16-ffc-prep-1.jpg) + + ![The flat flex cable with the small cover on the top of it being held lightly](/images/16-ffc-prep-3.jpg) + ![The flat flex cable with the small cover on the top removed, revealing the conductors](/images/16-ffc-prep-1.jpg) + Push the exposed conductors of the flat flex cable through the matching holes on the motherboard. This is designed to go together easily, just be take care not to bend any of the conductors. diff --git a/user_guide/docs/images/double.png b/user_guide/docs/images/double.png deleted file mode 100644 index 445dd87..0000000 Binary files a/user_guide/docs/images/double.png and /dev/null differ diff --git a/user_guide/docs/images/dual-wielding.svg b/user_guide/docs/images/dual-wielding.svg new file mode 100644 index 0000000..3adb656 --- /dev/null +++ b/user_guide/docs/images/dual-wielding.svg @@ -0,0 +1,183 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/line-mono-alt.svg b/user_guide/docs/images/line-mono-alt.svg new file mode 100644 index 0000000..df0cb62 --- /dev/null +++ b/user_guide/docs/images/line-mono-alt.svg @@ -0,0 +1,94 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/line-mono.svg b/user_guide/docs/images/line-mono.svg new file mode 100644 index 0000000..008c258 --- /dev/null +++ b/user_guide/docs/images/line-mono.svg @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/line-split-mono.svg b/user_guide/docs/images/line-split-mono.svg new file mode 100644 index 0000000..d966820 --- /dev/null +++ b/user_guide/docs/images/line-split-mono.svg @@ -0,0 +1,100 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/line-split-stereo.svg b/user_guide/docs/images/line-split-stereo.svg new file mode 100644 index 0000000..3c687aa --- /dev/null +++ b/user_guide/docs/images/line-split-stereo.svg @@ -0,0 +1,107 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/line-stereo.svg b/user_guide/docs/images/line-stereo.svg new file mode 100644 index 0000000..4c69b46 --- /dev/null +++ b/user_guide/docs/images/line-stereo.svg @@ -0,0 +1,109 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/mono-headphones.png b/user_guide/docs/images/mono-headphones.png deleted file mode 100644 index 8b4041a..0000000 Binary files a/user_guide/docs/images/mono-headphones.png and /dev/null differ diff --git a/user_guide/docs/images/mono-in-headphones.svg b/user_guide/docs/images/mono-in-headphones.svg new file mode 100644 index 0000000..b11035b --- /dev/null +++ b/user_guide/docs/images/mono-in-headphones.svg @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/mono-in-speaker.svg b/user_guide/docs/images/mono-in-speaker.svg new file mode 100644 index 0000000..3139462 --- /dev/null +++ b/user_guide/docs/images/mono-in-speaker.svg @@ -0,0 +1,93 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/mono-line-2.png b/user_guide/docs/images/mono-line-2.png deleted file mode 100644 index 957b4c5..0000000 Binary files a/user_guide/docs/images/mono-line-2.png and /dev/null differ diff --git a/user_guide/docs/images/mono-line-split.png b/user_guide/docs/images/mono-line-split.png deleted file mode 100644 index fbe66b2..0000000 Binary files a/user_guide/docs/images/mono-line-split.png and /dev/null differ diff --git a/user_guide/docs/images/mono-line.png b/user_guide/docs/images/mono-line.png deleted file mode 100644 index 03551e7..0000000 Binary files a/user_guide/docs/images/mono-line.png and /dev/null differ diff --git a/user_guide/docs/images/mono-speaker.png b/user_guide/docs/images/mono-speaker.png deleted file mode 100644 index a2638f9..0000000 Binary files a/user_guide/docs/images/mono-speaker.png and /dev/null differ diff --git a/user_guide/docs/images/stereo-headphones.png b/user_guide/docs/images/stereo-headphones.png deleted file mode 100644 index c09dbd0..0000000 Binary files a/user_guide/docs/images/stereo-headphones.png and /dev/null differ diff --git a/user_guide/docs/images/stereo-in-headphones.svg b/user_guide/docs/images/stereo-in-headphones.svg new file mode 100644 index 0000000..d5163b5 --- /dev/null +++ b/user_guide/docs/images/stereo-in-headphones.svg @@ -0,0 +1,97 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/stereo-in-speaker.svg b/user_guide/docs/images/stereo-in-speaker.svg new file mode 100644 index 0000000..62cced8 --- /dev/null +++ b/user_guide/docs/images/stereo-in-speaker.svg @@ -0,0 +1,100 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/user_guide/docs/images/stereo-line-split.png b/user_guide/docs/images/stereo-line-split.png deleted file mode 100644 index 9ce63cb..0000000 Binary files a/user_guide/docs/images/stereo-line-split.png and /dev/null differ diff --git a/user_guide/docs/images/stereo-line.png b/user_guide/docs/images/stereo-line.png deleted file mode 100644 index d8e6150..0000000 Binary files a/user_guide/docs/images/stereo-line.png and /dev/null differ diff --git a/user_guide/docs/images/stereo-speaker.png b/user_guide/docs/images/stereo-speaker.png deleted file mode 100644 index 013ea33..0000000 Binary files a/user_guide/docs/images/stereo-speaker.png and /dev/null differ diff --git a/user_guide/docs/index.md b/user_guide/docs/index.md index be6f0a9..e9df631 100644 --- a/user_guide/docs/index.md +++ b/user_guide/docs/index.md @@ -7,30 +7,30 @@ ## Specifications * Available [assembled](https://winterbloom.com/shop/speak-to-me) or as a [kit](https://winterbloom.com/shop/speak-to-me-kit) -* 6 HP -* +12v @ 15 to 150mA, -12v @ 5mA -* 30mm deep +* `6 HP` +* `+12v @ 15 to 150mA`, `-12v @ 5mA` +* `30mm` deep * Stereo input, with right channel normalled to left * Stereo 1/4" TRS output suitable for headphones and line level. -* Mono, 1.4W speaker +* Mono, `1.4W` speaker * [ModularGrid page](https://www.modulargrid.net/e/winterbloom-speak-to-me) - ## Getting support and help -We want you to have a wonderful experience with your module. If you need help or run into problems, please reach out to us. Email is the best way for product issues, whereas Discord and GitHub are great for getting advice and help on how to customize your module. +We want you to have a wonderful experience with your module. If you need help or run into problems, please reach out to us. [Email] is the best way for product issues, whereas [Discord] and [GitHub][github issues] are great for getting advice and help on how to customize your module. + +- Send us [an email][email] +- File a bug [on GitHub][github issues] +- Reach out on the [Discord][discord] -* Send us [an email](mailto:support@winterbloom.com) -* File a bug [on GitHub](https://github.com/wntrblm/Castor_and_Pollux/issues) -* Reach out on the [Discord][discord] +[github issues]: https://github.com/wntrblm/Speak_to_Me/issues +[discord]: https://discord.gg/UpfqghQ +[email]: mailto:support@winterbloom.com ## Installing the module -To install this into your Eurorack setup: - -1. Connect a Eurorack power cable from your power supply to the back of the module. **Note that even though the power connector on the module is keyed, double check that the red stripe is on the side labeled `red stripe`!** -1. Screw the module to your rack's rails. Be sure to screw it in tightly, as the speaker will cause unwanted vibrations if not secured to the case. +To install this into your Eurorack setup, connect a Eurorack power cable from your power supply to the back of the module. **Note that even though there's a keyed power connector on the module, double check that the red stripe is on the side labeled `red stripe`!** Once you've connected the power cable, secure your module to your rack rails using screws. ## Making connections @@ -39,7 +39,7 @@ There's a few different ways that you can patch Speak to Me depending on your se ### Mono in with speaker -![Mono input with the speaker active](/images/mono-speaker.png){: .dark-invert } +![Mono input with the speaker active](images/mono-in-speaker.svg) The most basic setup. Connect Eurorack-level audio to the top 3.5mm jack and Speak to Me will play the audio through its speaker @@ -47,7 +47,7 @@ This is great for small setups but also super useful in larger racks if you want ### Stereo in with speaker -![Stereo input with speaker active](/images/stereo-speaker.png){: .dark-invert } +![Stereo input with speaker active](images/stereo-in-speaker.svg) Connect the Eurorack-level audio signal for the left channel to the top 3.5mm jack and the signal for the right channel to the bottom 3.5mm jack. Speak to Me will downmix the two signals to mono and play the audio through the speaker. @@ -56,7 +56,7 @@ to monitor two (possibly unrelated) signals at the same time. ### Mono in with headphones -![Mono input with headphones](/images/mono-headphones.png){: .dark-invert } +![Mono input with headphones](images/mono-in-headphones.svg) Connect Eurorack-level audio to the top 3.5mm jack and connect a pair of stereo headphones to the larger 1/4" TRS jack. Speak to Me will play the audio through both the left and right headphone - no need to patch the same signal twice. The speaker is automatically turned off when headphones are connected. @@ -64,7 +64,7 @@ Just like with the previous setup, this is wonderful for small setups and monito ### Stereo in with headphones -![Stereo input with headphones](/images/stereo-headphones.png){: .dark-invert } +![Stereo input with headphones](images/stereo-in-headphones.svg) Connect the Eurorack-level audio signal for the left channel to the top 3.5mm jack and the signal for the right channel to the bottom 3.5mm jack. Connect a pair of stereo headphones to the larger 1/4" TRS jack. Speak to Me will play the audio through the headphones. The speaker is automatically turned off when headphones are connected. @@ -78,18 +78,18 @@ Next, connect Speak to Me's 1/4" stereo output to your mixer, interface, or othe If your equipment has a **stereo** line input, you can use a 1/4" TRS stereo cable [like this one](https://hosatech.com/products/analog-audio/interconnect-cables/single-interconnects/css-100/). Even though the interconnect is a stereo cable, Speak to Me will send the same signal to both channels: -![Mono input with stereo cable line out](/images/mono-line.png){: .dark-invert } +![Mono input with stereo cable line out](images/line-mono.svg) If your equipment has **mono** line, instrument, or microphone inputs such as those commonly found on recording interfaces, you can use a 1/4" TRS to 1/4" TS to adapter [like this one](https://hosatech.com/products/analog-audio/adapters/general-adapters/gpp-419/): -![Mono input with mono cable line out](/images/mono-line-2.png){: .dark-invert } +![Mono input with mono cable line out](images/line-mono-alt.svg) -!!! Note +!!! Warning "Mono cables" We highly recommend using the TRS to TR adapter over using a typical mono 1/4" TR cable. Using a mono cable directly might, in extreme cases, cause some audio issues such as "hiccups". This is because using a mono cable shorts the signal on the ring connector to ground and causes the module to draw more power. Speak to Me is [designed to operate](#warranty-disclaimers-and-limits) under these conditions, but we wanted to let you know just in case. Alternatively, you can use a 1/4" TRS Y-cable [like this one](https://hosatech.com/products/analog-audio/stereo-breakouts/hosa-breakouts/cmp-150/) as an adapter. You can connect either end of the Y cable to your equipment. -![Mono input with split cable line out](/images/mono-line-split.png){: .dark-invert } +![Mono input with split cable line out](images/line-split-mono.svg) This setup is great for getting audio out of your Eurorack and into a recording, mixer, or line-level effects units. @@ -101,17 +101,17 @@ Next, connect Speak to Me's 1/4" stereo output to your mixer, interface, or othe If your equipment has a **stereo** line input, you can use a 1/4" TRS stereo cable [like this one](https://hosatech.com/products/analog-audio/interconnect-cables/single-interconnects/css-100/): -![Stereo input with stereo line out](/images/stereo-line.png){: .dark-invert } +![Stereo input with stereo line out](images/line-stereo.svg) However, if your equipment has **mono** line, instrument, or microphone inputs such as those commonly found on recording interfaces, you'll need to use a 1/4" TRS Y-cable [like this one](https://hosatech.com/products/analog-audio/stereo-breakouts/hosa-breakouts/cmp-150/) to split the left and right channels. You'll then connect each channel into a separate input on your equipment: -![Stereo input with split line out](/images/stereo-line-split.png){: .dark-invert } +![Stereo input with split line out](images/line-split-stereo.svg) Like the mono setup, this is great for getting audio out of your Eurorack and into a recording, mixer, or line-level effects units. It's especially useful if you have modules that produce stereo effects or if you want to record two independent patches at the same time. ### Stereo speakers -![Stereo speaker setup using two Speak to Me modules](/images/double.png){: .dark-invert } +![Stereo speaker setup using two Speak to Me modules](images/dual-wielding.svg) If you happen to have **two** Speak to Me modules, you can set up one module on each side of your rack and use them as a pair of stereo speakers. Connect your right channel signal to the top 3.5mm input on the right-side Speak to Me and connect the left channel signal to the top 3.5mm input on the left side. @@ -132,7 +132,7 @@ Speak to Me is completely open source and hacking is encouraged. The [hardware design](https://github.com/wntrblm/Speak_to_Me/tree/main/hardware) is available under the permissive [CERN-OHL-P v2](https://cern-ohl.web.cern.ch/) and is designed using [KiCAD](https://kicad.org/) which is free and open-source. You can open the hardware files using KiCAD or you can [check out a PDF of the schematic](https://github.com/wntrblm/Speak_to_Me/tree/main/hardware/board/board.pdf). -![Open Source Hardware Association mark](images/oshw.svg){class=oshw} Speak to Me is [certified open source hardware](https://certification.oshwa.org/us002060.html) +![Open Source Hardware Association mark](images/oshw.svg){: .inline .small } Speak to Me is [certified open source hardware](https://certification.oshwa.org/us002060.html) ## Warranty, disclaimers, and limits diff --git a/user_guide/docs/scripts/svgmap.js b/user_guide/docs/scripts/svgmap.js deleted file mode 100644 index 888a255..0000000 --- a/user_guide/docs/scripts/svgmap.js +++ /dev/null @@ -1,128 +0,0 @@ -/* - An advanced imagemap using SVG. - - element attributes: - - data-is-svg-map: attaches this functionality. - - data-list: element ID of a containing that map the - IDs of SVG areas to descriptions. - - data-stylesheet: href to stylesheet to apply inside of the SVG. - - The stylesheet should have styles for .hoverable, .hoverable:hover, and - .info-text. -*/ -class SVGMap { - constructor(object_elem) { - this.object_elem = object_elem; - this.svg_doc = object_elem.contentDocument; - - this.svg_doc = object_elem.contentDocument; - this.svg_elem = this.svg_doc.querySelector("svg"); - apply_safari_img_in_svg_fix(this.svg_elem); - - this.insert_stylesheet().then(() => { - this.insert_help_text(); - this.insert_info_text(); - this.attach_event_listeners(); - }); - } - - insert_help_text() { - const help_text_elem = document.createElement("p"); - help_text_elem.innerText = "Hover or tap an item"; - help_text_elem.classList.add("svgmap-help-text"); - this.object_elem.parentNode.insertBefore( - help_text_elem, - this.object_elem.nextSibling - ); - } - - async insert_stylesheet() { - const resp = await fetch(this.object_elem.dataset.stylesheet); - const style_elem = this.svg_doc.createElementNS( - "http://www.w3.org/2000/svg", - "style" - ); - style_elem.setAttribute("type", "text/css"); - style_elem.textContent = await resp.text(); - this.svg_elem.appendChild(style_elem); - } - - insert_info_text() { - const info_text_template = document.getElementById( - this.object_elem.dataset.infoTextTemplate - ); - let info_text_elem = null; - - if (info_text_template !== null) { - /* Translate the HTML template into and SVG defs so the namespace is correct. */ - const svg_defs = this.svg_doc.createElementNS( - "http://www.w3.org/2000/svg", - "defs" - ); - svg_defs.innerHTML = info_text_template.innerHTML; - info_text_elem = svg_defs.firstElementChild; - } else { - info_text_elem = this.svg_doc.createElementNS( - "http://www.w3.org/2000/svg", - "text" - ); - info_text_elem.setAttribute("id", "info-text"); - } - this.svg_elem.appendChild(info_text_elem); - - /* We only need the text element from this point on. */ - this.info_text_container = info_text_elem; - this.info_text = this.svg_doc.getElementById("info-text"); - this.info_text.textContent = ""; - - /* Check if there's a rect that's set to follow the text's size. */ - this.rect = this.svg_doc.querySelector("rect[data-size-to]"); - } - - update_bounding_rect() { - if (this.rect === null) return; - const bb = this.info_text.getBBox(); - this.rect.setAttribute("x", bb.x); - this.rect.setAttribute("y", bb.y); - this.rect.setAttribute("width", bb.width); - this.rect.setAttribute("height", bb.height); - } - - attach_event_listeners() { - const datalist = document.getElementById(this.object_elem.dataset.list); - for (let item of datalist.options) { - const item_elem = this.svg_doc.getElementById(item.value); - item_elem.classList.add("hoverable"); - item_elem.addEventListener("mouseenter", () => { - this.info_text.textContent = item.label; - this.info_text_container.classList.add("visible"); - this.info_text_container.dataset.value = item.value; - this.update_bounding_rect(); - }); - item_elem.addEventListener("mouseleave", () => { - this.info_text_container.classList.remove("visible"); - }); - } - } -} - -window.addEventListener("load", () => { - const svg_maps = document.querySelectorAll("object[data-is-svg-map]"); - for (const elem of svg_maps) { - new SVGMap(elem); - } -}); - -const is_safari = /apple/i.test(navigator.vendor); - -function apply_safari_img_in_svg_fix(svg) { - /* Fix for safari, which continues to be the most obnoxious browser. */ - if (is_safari) { - for (let elem of svg.querySelectorAll("[*|href]")) { - elem.setAttribute( - "href", - elem.getAttributeNS("http://www.w3.org/1999/xlink", "href") - ); - } - } -} diff --git a/user_guide/docs/styles/kit-contents-svgmap.css b/user_guide/docs/styles/kit-contents-svgmap.css deleted file mode 100644 index b25b3b1..0000000 --- a/user_guide/docs/styles/kit-contents-svgmap.css +++ /dev/null @@ -1,37 +0,0 @@ -.hoverable { - fill: #1ba8b800 !important; - stroke-width: 10 !important; - stroke: #1ba8b8 !important; - mix-blend-mode: color !important; - filter: blur(20px) !important; - opacity: 1; - transition: 0.1s; -} - -.hoverable:hover { - fill: #1ba8b8 !important; - stroke: #1ba8b800 !important; - opacity: 1; -} - -#info-text-container { - transform: translate(50%, 95%); - opacity: 0; - transition: 0.1s; -} - -#info-text-container.visible { - opacity: 1; -} - -#info-text-container rect { - fill: #1ba8b8; - transform: translate(0, 0.4em) scale(1.2, 1.5); -} - -#info-text { - font-family: Overpass, sans-serif; - font-size: 3em; - text-anchor: middle; - fill: white; -} diff --git a/user_guide/docs/styles/svgmap.css b/user_guide/docs/styles/svgmap.css deleted file mode 100644 index b988fb0..0000000 --- a/user_guide/docs/styles/svgmap.css +++ /dev/null @@ -1,9 +0,0 @@ -object[data-is-svg-map] { - max-height: 90vh; -} - -.svgmap-help-text { - text-align: center; - font-style: italic; - font-size: 80%; -} diff --git a/user_guide/mkdocs.yml b/user_guide/mkdocs.yml index 1f76f01..0c8674f 100644 --- a/user_guide/mkdocs.yml +++ b/user_guide/mkdocs.yml @@ -1,26 +1,47 @@ -site_name: Winterbloom Speak to Me User Guide +site_name: Speak to Me site_url: https://speak.wntr.dev -copyright: "© 2021 Winterbloom, licensed under Creative Commons CC BY-SA 4.0" repo_url: "https://github.com/wntrblm/Speak_to_Me" edit_uri: edit/main/user_guide/docs theme: - name: winterbloom + name: wintersong +plugins: [] markdown_extensions: + - abbr - admonition - def_list - attr_list + - footnotes + - md_in_html - toc: permalink: "#" - toc_depth: 2-3 + toc_depth: 2-2 + - pymdownx.arithmatex: + generic: true + - pymdownx.betterem: + smart_enable: all + - pymdownx.blocks.tab: + alternate_style: true + - pymdownx.caret + - pymdownx.details - pymdownx.highlight: - use_pygments: True + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.keys + - pymdownx.magiclink: + hide_protocol: true + repo_url_shortener: true + social_url_shortener: true + normalize_issue_symbols: true + repo_url_shorthand: true + user: wntrblm + repo: winter + - pymdownx.mark - pymdownx.superfences - - pymdownx.magiclink - - md_in_html - - markdown_link_attr_modifier: - new_tab: "external_only" - custom_attrs: - referrerpolicy: "origin" + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde nav: - - "User Guide": index.md - - "Kit Build Instructions": build.md + - "Manual": index.md + - "Build": build.md