Merge pull request #146 from vados-cosmonic/feat=improve-js-lang-docs

feat: improve JS lang docs

.github/workflows/mdbook.yml

@@ -31,6 +31,7 @@ jobs:
     env:
       MDBOOK_VERSION: 0.4.21
       SITEMAP_GEN_VERSION: 0.2.0
+      ALERTS_VERSION: 0.6.7
       PUBLISH_DOMAIN: component-model.bytecodealliance.org
     steps:
       - uses: actions/checkout@v3
@@ -40,6 +41,7 @@ jobs:
           rustup update
           cargo install --version ${MDBOOK_VERSION} mdbook
           cargo install --version ${SITEMAP_GEN_VERSION} mdbook-sitemap-generator
+          cargo install --version ${ALERTS_VERSION} mdbook-alerts
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v3

CONTRIBUTING.md

@@ -10,6 +10,16 @@ You can run the website locally using the [mdBook](https://rust-lang.github.io/m
 
 To use this repository, you need [mdBook](https://rust-lang.github.io/mdBook/guide/installation.html) installed on your workstation.
 
+This repository also makes use of mdBook plugins. To install mdBook and the plugins for this project, you can use [`cargo`][cargo]:
+
+```console
+cargo install --version 0.4.21 mdbook
+cargo install --version 0.2.0 mdbook-sitemap-generator
+cargo install --version 0.6.7 mdbook-alerts
+```
+
+[cargo]: https://doc.rust-lang.org/cargo
+
 ### Running the website locally
 
 After installing mdBook, you'll need to clone the code via git and navigate to the directory.

component-model/book.toml

@@ -8,4 +8,6 @@ title = "The WebAssembly Component Model"
 [output.html]
 git-repository-url = "https://github.com/bytecodealliance/component-docs/tree/main/component-model"
 edit-url-template = "https://github.com/bytecodealliance/component-docs/tree/main/component-model/{path}"
-additional-css = ["theme/head.hbs"]
+additional-css = ["theme/head.hbs"]
+
+[preprocessor.alerts]