actix-website/README.md

Actix Website

Getting Started

Building the website depends on Docusaurus, you must have npm or yarn installed. You can run the site locally with:

git clone https://github.com/actix/actix-website.git
cd actix-website
npm install  # or yarn install
npm start  # or yarn start

Then visit http://localhost:3000.

Updating diagrams

Diagrams are located under /static/img/diagrams/ and built with Mermaid CLI.

For instance to edit connection_overview diagram:

cd static/img/diagrams
vi connection_overview.mmd
# Compile diagrams:
mmdc -i connection_overview.mmd -o connection_overview.svg

License

This site is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)