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
478 Commits 1 Branch 3 Tags 12 MiB
HTML 47.6%
JavaScript 36.3%
SCSS 10.2%
CSS 5.9%
3167a55853
Go to file
Mark Lodato 3167a55853
Improve error handler example (#248)
2021-12-22 18:36:35 +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 Improve error handler example (#248) 2021-12-22 18:36:35 +00:00
i18n v3 (#188) 2020-09-12 16:21:54 +01:00
layouts Added missing closing </a> and </li> tag (#246) 2021-12-05 14:33:57 +00:00
static please preserve my eyesight and add a dark mode (#244) 2021-12-05 19:53:36 +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

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.