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

migrate to docusaurus (v2) (#266)

Browse Source 
Co-authored-by: ibraheemdev <ibrah1440@gmail.com>
This commit is contained in:
Santiago
2022-07-16 11:59:20 +02:00
committed by GitHub
parent a85b4ff5a3
commit 8393aea71a
85 changed files with 23020 additions and 4357 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -2,32 +2,25 @@
## 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:
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
hugo server
npm install # or yarn install
npm start # or yarn start
```
Then visit http://localhost:1313.
Then visit http://localhost:3000.
## 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].
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/css/img/diagrams
cd static/img/diagrams
vi connection_overview.mmd
# Compile diagrams:
mmdc -i connection_overview.mmd -o connection_overview.svg
@ -35,10 +28,14 @@ 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.
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 -->
[hugo]: https://gohugo.io
[homebrew]: https://brew.sh
[Docusaurus]: https://docusaurus.io/
[mermaid cli]: https://github.com/mermaidjs/mermaid.cli