actix/actix-website
1
0
Fork 0
mirror of https://github.com/actix/actix-website synced 2025-06-27 07:29:02 +02:00
Code Issues Releases Wiki Activity

v3 (#188)

Browse Source
This commit is contained in:
Rob Ede
2020-09-12 16:21:54 +01:00
committed by GitHub
parent a0ce9f28e2
commit 4d8d53cea5
145 changed files with 1011 additions and 1461 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -4,11 +4,12 @@ The work in progress website for the actix project based on tokio's website.
## Getting Started
Building the website depends on [Hugo](http://gohugo.io). So, first make sure
that you have it installed. If on OS X and using Homebrew, run the following:
Building the website depends on [Hugo]. So, first make sure
that you have it installed. If on macOS and using [Homebrew], run the following:
```sh
brew update && brew install hugo
brew update
brew install hugo
```
Then, get the website running locally:
@ -16,16 +17,18 @@ Then, get the website running locally:
```sh
git clone https://github.com/actix/actix-website.git
cd actix-website
hugo server
```
Then visit [http://localhost:1313](http://localhost:1313).
Then visit http://localhost:1313.
## Updating diagrams
Diagrams are located under [/static/css/img/diagrams/](https://github.com/actix/actix-website/tree/master/static/img/diagrams) and built with [Mermaid CLI](https://github.com/mermaidjs/mermaid.cli).
Diagrams are located under [/static/css/img/diagrams/](https://github.com/actix/actix-website/tree/master/static/img/diagrams) and built with [Mermaid CLI].
For instance to edit `connection_overview` diagram:
```sh
cd static/css/img/diagrams
vi connection_overview.mmd
@ -35,5 +38,11 @@ mmdc -i connection_overview.mmd -o connection_overview.svg
# License
Pretty murky. Right now a massive clone of the tokio website. Will get this
Pretty murky. Right now a massive clone of the tokio website. Will get this
figured out as we go along.
<!-- LINKS -->
[Hugo]: https://gohugo.io
[Homebrew]: https://brew.sh
[Mermaid CLI]: https://github.com/mermaidjs/mermaid.cli