https://github.com/actix/actix-website
The Actix Web website.
https://github.com/actix/actix-website
actix actix-web
Last synced: 3 months ago
JSON representation
The Actix Web website.
- Host: GitHub
- URL: https://github.com/actix/actix-website
- Owner: actix
- License: apache-2.0
- Created: 2018-01-07T02:55:52.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T07:18:38.000Z (about 1 year ago)
- Last Synced: 2024-04-14T03:01:27.301Z (about 1 year ago)
- Topics: actix, actix-web
- Language: HTML
- Homepage: https://actix.rs
- Size: 6.26 MB
- Stars: 184
- Watchers: 20
- Forks: 240
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Actix Website
## Getting Started
Building the website depends on [Docusaurus][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 .
## 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 )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
[docusaurus]: https://docusaurus.io/
[mermaid_cli]: https://github.com/mermaidjs/mermaid.cli