mirror of
https://github.com/actix/actix-website
synced 2024-11-30 19:14:36 +01:00
45 lines
1008 B
Markdown
45 lines
1008 B
Markdown
# 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:
|
|
|
|
```sh
|
|
brew update
|
|
brew install hugo
|
|
```
|
|
|
|
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.
|
|
|
|
## 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].
|
|
|
|
For instance to edit `connection_overview` diagram:
|
|
|
|
```sh
|
|
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.
|
|
|
|
<!-- LINKS -->
|
|
|
|
[hugo]: https://gohugo.io
|
|
[homebrew]: https://brew.sh
|
|
[mermaid cli]: https://github.com/mermaidjs/mermaid.cli
|