1
0
mirror of https://github.com/actix/actix-website synced 2024-11-23 16:31:08 +01:00
The Actix website. https://actix.rs
Go to file
2022-01-21 13:35:20 +00:00
.github/workflows Update github-pages-deploy-action to 4.1.1 (#223) 2021-04-06 08:37:41 +09:00
artwork Update website 2018-05-22 23:15:08 +02:00
content Improve json documentation (#245) 2021-12-05 14:41:37 +00:00
examples Update logger example (#250) 2022-01-01 22:05:37 +00:00
i18n v3 (#188) 2020-09-12 16:21:54 +01:00
layouts 📝 updated copyright year (#252) 2022-01-21 13:35:20 +00:00
static Make navbar icon visible in dark mode (mobile) (#249) 2021-12-30 18:17:21 +00:00
.gitignore v3 (#188) 2020-09-12 16:21:54 +01:00
.prettierrc.json v3 (#188) 2020-09-12 16:21:54 +01:00
CNAME Update website 2018-05-22 23:15:08 +02:00
config.toml v3 (#188) 2020-09-12 16:21:54 +01:00
LICENSE-APACHE Update website 2018-05-22 23:15:08 +02:00
LICENSE-MIT Update website 2018-05-22 23:15:08 +02:00
README.md Update README.md 2020-10-01 15:45:28 +01:00

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.