Update the C API document. (#127)

1. Update to use the prettier code note block.
2. Update the latest C API document.

Signed-off-by: YiYing He <[email protected]>

Author: q82419

docs/contribute/contribute.md

@@ -20,14 +20,15 @@ Pull requests are always welcome, even if they only contain small fixes like typ
 
 Please submit a pull request broken down into small changes bit by bit. A pull request consisting of a lot features and code changes may be hard to review. It is recommended to submit pull requests in an incremental fashion.
 
-> If you split your pull request into small changes, please make sure any of the changes that goes to master will not break anything. Otherwise, it can not be merged until this feature is complete.
+<!-- prettier-ignore -->
+:::note
+If you split your pull request into small changes, please make sure any of the changes that goes to master will not break anything. Otherwise, it can not be merged until this feature is complete.
+:::
 
 ### Fork and Clone the Repository
 
 Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace
 
-> The WasmEdge team builds lots of extensions of Server-side WebAssembly, like [TensorFlow](https://github.com/second-state/WasmEdge-tensorflow), [Storage](https://github.com/second-state/WasmEdge-storage), [Command interface] and so on. If you want to contribute to the extensions, please check out [the details here](../develop/wasmedge/extensions/unique_extensions).
-
 ### Branches and Commits
 
 Changes should be made on your own fork in a new branch. Pull requests should be rebased on the top of master.

docs/contribute/plugin/develop_plugin_c.md

@@ -20,7 +20,10 @@ The goal of the plug-in is to provide the host functions which can be imported w
 
 Therefore, developers can implement their plug-in host functions first, as the same as the [host functions in WasmEdge C API](/embed/c/reference/latest.md#host-functions).
 
-> For the more details about the [external data](/embed/c/host_function.md#host-data) and [calling frame context](/embed/c/host_function.md#calling-frame-context), please refer to the host function guide.
+<!-- prettier-ignore -->
+:::note
+For the more details about the [external data](/embed/c/host_function.md#host-data) and [calling frame context](/embed/c/host_function.md#calling-frame-context), please refer to the host function guide.
+:::
 
 ```c
 #include <wasmedge/wasmedge.h>

docs/contribute/plugin/develop_plugin_cpp.md

@@ -4,7 +4,10 @@ sidebar_position: 3
 
 # Develop WasmEdge Plug-in in C++ API
 
-> We recommend developers to [develop plug-ins in WasmEdge C API](develop_plugin_c.md).
+<!-- prettier-ignore -->
+:::note
+We recommend developers to [develop plug-ins in WasmEdge C API](develop_plugin_c.md).
+:::
 
 ## Prerequisites
 

docs/contribute/plugin/intro.md

@@ -22,8 +22,6 @@ Please [refer to the plugin example code](https://github.com/WasmEdge/WasmEdge/t
 
 There are several plug-in releases with the WasmEdge official releases. Please check the following table to check the release status and how to build from source with the plug-ins.
 
-> The `WasmEdge-Process` plug-in is attached in the WasmEdge release tarballs.
-
 | Plug-in | Rust Crate | Released Platforms | Build Steps |
 | --- | --- | --- | --- |
 | WasmEdge-Process | [wasmedge_process_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, and `ubuntu 20.04 x86_64` (since `0.10.0`) | [Build Wtih WasmEdge-Process](/contribute/source/plugin/process) |
@@ -35,7 +33,10 @@ There are several plug-in releases with the WasmEdge official releases. Please c
 | WasmEdge-Tensorflow | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-Tensorflow](/contribute/source/plugin/tensorflow) |
 | WasmEdge-TensorflowLite | [wasmedge_tensorflow_interface][] | `manylinux2014 x86_64`, `manylinux2014 aarch64`, `ubuntu 20.04 x86_64`, `darwin x86_64`, and `darwin arm64` (since `0.13.0`) | [Build With WasmEdge-TensorflowLite](/contribute/source/plugin/tensorflowlite) |
 
-> Due to the `OpenVINO` dependency, we only release the WASI-NN plug-in for the `OpenVINO` backend on `Ubuntu 20.04 x86_64` now. We'll work with `manylinux2014` versions in the future.
+<!-- prettier-ignore -->
+:::note
+Due to the `OpenVINO` dependency, we only release the WASI-NN plug-in for the `OpenVINO` backend on `Ubuntu 20.04 x86_64` now. We'll work with `manylinux2014` versions in the future.
+:::
 
 [wasmedge_process_interface]: https://crates.io/crates/wasmedge_process_interface
 [wasmedge_tensorflow_interface]: https://crates.io/crates/wasmedge_tensorflow_interface

docs/contribute/source/os/android/build.md

@@ -21,7 +21,10 @@ However, the WasmEdge installer does not support Android. The user must download
 
 Please follow this guide to build and test WasmEdge from source code with Android NDK.
 
-> In current state, we only support the runtime for the interpreter mode.
+<!-- prettier-ignore -->
+:::note
+In current state, we only support the runtime for the interpreter mode.
+:::
 
 ## Prepare the Environment
 

docs/contribute/source/os/openwrt.md

@@ -6,7 +6,10 @@ sidebar_position: 5
 
 Please follow this tutorial to build and test WasmEdge in OpenWrt(x86_64) from source code.
 
-> Currently, we only support the runtime for the interpreter mode.
+<!-- prettier-ignore -->
+:::note
+Currently, we only support the runtime for the interpreter mode.
+:::
 
 ## Prepare the Environment
 

docs/contribute/source/os/sel4.md

@@ -34,7 +34,10 @@ $ docker run --rm -v $(pwd):/app -it wasmedge/sel4_build
 (docker) root#
 ```
 
-> If you do not want to build the seL4 system simulator yourself, you can download the [build artifact](https://github.com/second-state/wasmedge-seL4/actions/runs/1374510169) from our GitHub Actions, and skip directly to [Boot wasmedge-seL4](#boot-wasmedge-sel4)
+<!-- prettier-ignore -->
+:::note
+If you do not want to build the seL4 system simulator yourself, you can download the [build artifact](https://github.com/second-state/wasmedge-seL4/actions/runs/1374510169) from our GitHub Actions, and skip directly to [Boot wasmedge-seL4](#boot-wasmedge-sel4)
+:::
 
 ### Automatic installation: all-in-one script
 

docs/contribute/source/plugin/wasi_logging.md

@@ -20,6 +20,9 @@ cmake -DCMAKE_BUILD_TYPE=Release -DWASMEDGE_PLUGIN_WASI_LOGGING=ON .. && make -j
 cmake --install .
 ```
 
-> If the built `wasmedge` CLI tool cannot find the WASI-Logging plug-in, you can set the `WASMEDGE_PLUGIN_PATH` environment variable to the plug-in installation path (`/usr/local/lib/wasmedge`, or the built plug-in path `build/plugins/wasi_logging`) to try to fix this issue. You should find `libwasmedgePluginWasiLogging.so` in your `WASMEDGE_PLUGIN_PATH`
+<!-- prettier-ignore -->
+:::note
+If the built `wasmedge` CLI tool cannot find the WASI-Logging plug-in, you can set the `WASMEDGE_PLUGIN_PATH` environment variable to the plug-in installation path (`/usr/local/lib/wasmedge`, or the built plug-in path `build/plugins/wasi_logging`) to try to fix this issue. You should find `libwasmedgePluginWasiLogging.so` in your `WASMEDGE_PLUGIN_PATH`
+:::
 
 Then you will have an executable `wasmedge` runtime under `/usr/local/bin` and the WASI-Logging plug-in under `/usr/local/lib/wasmedge/libwasmedgePluginWasiLogging.so` after installation.

docs/develop/c/hello_world.md

@@ -44,7 +44,10 @@ Save it in any file and then compile it to WebAssembly with emscripten .
 emcc hello.c -o hello.wasm
 ```
 
-> Note: Make sure you either supply `-s STANDALONE_WASM` flag or specify output as wasm `-o your_file_name.wasm`
+<!-- prettier-ignore -->
+:::note
+Make sure you either supply `-s STANDALONE_WASM` flag or specify output as wasm `-o your_file_name.wasm`
+:::
 
 Then run the wasm in wasmedge runtime
 

docs/develop/deploy/cri-runtime/crio-crun.md

@@ -43,7 +43,10 @@ systemctl start crio
 
 CRI-O uses the `runc` runtime by default and we need to configure it to use `crun` instead. That is done by adding to two configuration files.
 
-> Make sure that you have [built and installed the `crun` binary with WasmEdge support](../oci-runtime/crun.md) before starting the following steps.
+<!-- prettier-ignore -->
+:::note
+Make sure that you have [built and installed the `crun` binary with WasmEdge support](../oci-runtime/crun.md) before starting the following steps.
+:::
 
 First, create a `/etc/crio/crio.conf` file and add the following lines as its content. It tells CRI-O to use `crun` by default.
 
@@ -170,7 +173,10 @@ sudo crictl pull docker.io/avengermojo/http_server:with-wasm-annotation
 
 Next, we need to create two simple configuration files that specifies how CRI-O should run this WebAssembly image in a sandbox. We already have those two files [container_http_server.json](https://raw.githubusercontent.com/second-state/wasmedge-containers-examples/main/crio/http_server/container_http_server.json) and [sandbox_config.json](https://github.com/second-state/wasmedge-containers-examples/blob/main/crio/sandbox_config.json). You can just download them to your local directory as follows.
 
-> The `sandbox_config.json` file is the same for the simple WASI example and the HTTP server example. The other `container_*.json` file is application specific as it contains the application's Docker Hub URL.
+<!-- prettier-ignore -->
+:::note
+The `sandbox_config.json` file is the same for the simple WASI example and the HTTP server example. The other `container_*.json` file is application specific as it contains the application's Docker Hub URL.
+:::
 
 ```bash
 wget https://raw.githubusercontent.com/second-state/wasmedge-containers-examples/main/crio/sandbox_config.json