mirror of
https://github.com/actix/actix-website
synced 2024-11-27 18:12:57 +01:00
42 lines
1.1 KiB
Markdown
42 lines
1.1 KiB
Markdown
# Actix Website
|
|
|
|
## Getting Started
|
|
|
|
Building the website depends on [Docusaurus], you must have `npm` or `yarn` installed. You can run the site locally with:
|
|
|
|
```sh
|
|
git clone https://github.com/actix/actix-website.git
|
|
cd actix-website
|
|
npm install # or yarn install
|
|
npm start # or yarn start
|
|
```
|
|
|
|
Then visit http://localhost:3000.
|
|
|
|
## Updating diagrams
|
|
|
|
Diagrams are located under [/static/img/diagrams/](https://github.com/actix/actix-website/tree/master/static/img/diagrams) and built with [Mermaid CLI][mermaid cli].
|
|
|
|
For instance to edit `connection_overview` diagram:
|
|
|
|
```sh
|
|
cd static/img/diagrams
|
|
vi connection_overview.mmd
|
|
# Compile diagrams:
|
|
mmdc -i connection_overview.mmd -o connection_overview.svg
|
|
```
|
|
|
|
# License
|
|
|
|
This site is licensed under either of
|
|
|
|
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
|
|
[http://www.apache.org/licenses/LICENSE-2.0])
|
|
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
|
|
[http://opensource.org/licenses/MIT])
|
|
|
|
<!-- LINKS -->
|
|
|
|
[Docusaurus]: https://docusaurus.io/
|
|
[mermaid cli]: https://github.com/mermaidjs/mermaid.cli
|