mirror of
https://github.com/actix/actix-website
synced 2024-11-27 10:02:57 +01:00
The Actix website. https://actix.rs
|
|
||
|---|---|---|
| .github/workflows | ||
| artwork | ||
| content | ||
| examples | ||
| i18n | ||
| layouts | ||
| static | ||
| .gitignore | ||
| .prettierrc.json | ||
| CNAME | ||
| config.toml | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
Actix Website
Getting Started
Building the website depends on Hugo. So, first make sure that you have it installed. If on macOS and using Homebrew, run the following:
brew update
brew install hugo
Then, get the website running locally:
git clone https://github.com/actix/actix-website.git
cd actix-website
hugo server
Then visit http://localhost:1313.
Updating diagrams
Diagrams are located under /static/css/img/diagrams/ and built with Mermaid CLI.
For instance to edit connection_overview diagram:
cd static/css/img/diagrams
vi connection_overview.mmd
# Compile diagrams:
mmdc -i connection_overview.mmd -o connection_overview.svg
License
Pretty murky. Right now a massive clone of the tokio website. Will get this figured out as we go along.