actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2024-11-24 00:41:07 +01:00
Code Issues Releases Wiki Activity
The Actix website. https://actix.rs
435 Commits 1 Branch 3 Tags 9.7 MiB
HTML 47.6%
JavaScript 36.3%
SCSS 10.2%
CSS 5.9%
2d244b0e20
Go to file
Rob Ede 2d244b0e20
use getting started as homepage cta
2020-09-13 03:18:50 +01:00
.github/workflows Check examples on GHA 2020-07-18 15:24:49 +09:00
artwork Update website 2018-05-22 23:15:08 +02:00
content v3 (#188) 2020-09-12 16:21:54 +01:00
examples v3 (#188) 2020-09-12 16:21:54 +01:00
i18n v3 (#188) 2020-09-12 16:21:54 +01:00
layouts use getting started as homepage cta 2020-09-13 03:18:50 +01:00
static v3 (#188) 2020-09-12 16:21:54 +01: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 v3 (#188) 2020-09-12 16:21:54 +01:00

README.md

Actix Website

The work in progress website for the actix project based on tokio's 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.