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
a0ce9f28e2
actix-website/README.md
Maxim Vorobjov c1a8103cbc Architecture diagrams of HttpServer and Connection lifecycle (#148) 
* add arch diagrams and menu

* fix colors for arch diagrams

* refine architecture diagrams, ready for review

* capitalize titles and add mmdc instruction

* apply code review requested changes

* Add links to accept, worker and dispatcher too
2020-01-28 20:36:35 +09:00

1.0 KiB
Raw Blame History

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 OS X 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.