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 Project Activity

The homepage imports src/data/project-activity.json at build time. It does not request GitHub data in the browser. Dates use UTC and remain fixed until the next deployment.

The Update Project Activity workflow runs daily and can also run manually. It opens or updates chore/project-activity with the latest star count and stable Actix Web release. Merge the pull request to deploy through Netlify.

Enable Allow GitHub Actions to create and approve pull requests in the repository's Actions settings. Pull requests created with GITHUB_TOKEN do not automatically trigger other GitHub Actions workflows. Close and reopen the pull request as a maintainer to trigger the normal checks before merge. See GitHub's workflow trigger documentation.

To update the snapshot locally:

just update-project-activity

Set GITHUB_TOKEN to use authenticated API requests. Failed requests or invalid responses leave the previous snapshot intact. Normal site builds use the saved snapshot and do not need GitHub access.

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)