mirror of https://github.com/actix/actix-website synced 2024-11-27 10:02:57 +01:00

The Actix website. https://actix.rs

Go to file

Rob Ede 447edcc9d7 add note that server must be awaited		2022-02-26 05:01:13 +00:00
.github/workflows	Update github-pages-deploy-action to 4.1.1 (#223 )	2021-04-06 08:37:41 +09:00
.vscode	update examples to v4 (#258 )	2022-02-26 03:56:24 +00:00
artwork	Update website	2018-05-22 23:15:08 +02:00
content	add note that server must be awaited	2022-02-26 05:01:13 +00:00
examples	fix note about app_data	2022-02-26 04:50:39 +00:00
i18n	v3 (#188 )	2020-09-12 16:21:54 +01:00
layouts	update homepage	2022-02-26 04:38:18 +00:00
static	Make navbar icon visible in dark mode (mobile) (#249 )	2021-12-30 18:17:21 +00:00
.gitignore	update homepage	2022-02-26 04:38:18 +00:00
.prettierrc.yaml	fmt	2022-02-26 04:41:49 +00:00
CNAME	Update website	2018-05-22 23:15:08 +02:00
config.toml	update homepage	2022-02-26 04:38:18 +00:00
LICENSE-APACHE	update examples to v4 (#258 )	2022-02-26 03:56:24 +00:00
LICENSE-MIT	update examples to v4 (#258 )	2022-02-26 03:56:24 +00:00
README.md	fmt	2022-02-26 04:41:49 +00: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

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

Pretty murky. Right now a massive clone of the tokio website. Will get this figured out as we go along.