The Component Model documentation is a Bytecode Alliance project, and follows the Bytecode Alliance's Code of Conduct and Organizational Code of Conduct.
You can run the website locally using the mdBook command line tool.
To use this repository, you need mdBook installed on your workstation.
After installing mdBook, you'll need to clone the code via git and navigate to the directory.
git clone https://github.com/bytecodealliance/component-docs
cd component-docsTo build and test the site locally, run:
cd component-model
mdbook serve --openYou can use mdbook-linkcheck to check the links in the docs automatically. First, add the lines following lines in book.toml.
[output.linkcheck]
follow-web-links = trueAfter this, install the extension and build the project again. You should see the link checker do its work in the console output.
cargo install mdbook-linkcheck
mdbook buildDon't forget to remove the changes in book.toml before you commit!
You can click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork. Make any changes you want in your fork, and when you are ready to submit those changes, go to your fork and create a new pull request to let us know about it.
Everyone is welcome to submit a pull request! Once your pull request is created, we'll try to get to reviewing it or responding to it in at most a few days. As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the reviewer.