actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2024-12-03 20:22:13 +01:00
Code Issues Releases Wiki Activity
The Actix website. https://actix.rs
509 Commits 1 Branch 3 Tags 9.9 MiB
HTML 47.6%
JavaScript 36.3%
SCSS 10.2%
CSS 5.9%
7d988fc27e
Go to file
Rob Ede 7d988fc27e
improve extractors docs
2022-04-07 16:22:17 +01:00
.github/workflows Update github-pages-deploy-action to 4.1.1 (#223) 2021-04-06 08:37:41 +09:00
.vscode improve extractors docs 2022-04-07 16:22:17 +01:00
artwork Update website 2018-05-22 23:15:08 +02:00
content improve extractors docs 2022-04-07 16:22:17 +01:00
examples improve extractors docs 2022-04-07 16:22:17 +01:00
i18n v3 (#188) 2020-09-12 16:21:54 +01:00
layouts update homepage example 2022-03-05 23:34:31 +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

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.