Skip to content

scb01/actix-website

 
 

Repository files navigation

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 https://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

Packages

No packages published

Languages

  • HTML 41.3%
  • JavaScript 32.0%
  • Mermaid 12.8%
  • SCSS 8.8%
  • CSS 5.1%