mirror of
https://github.com/actix/actix-website
synced 2024-11-23 16:31:08 +01:00
The Actix website. https://actix.rs
a04f1bb6ff
Update docusaurus.config.js to add the "docusaurus-lunr-search" plugin and update package.json to use the latest versions of "@docusaurus/core" and "@docusaurus/preset-classic". |
||
|---|---|---|
| .github | ||
| .vscode | ||
| docs | ||
| examples | ||
| src | ||
| static | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierrc.yaml | ||
| babel.config.js | ||
| CNAME | ||
| docusaurus.config.js | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| vars.js | ||
Actix Website
Getting Started
Building the website depends on Docusaurus, you must have npm or yarn installed. You can run the site locally with:
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/ and built with Mermaid CLI.
For instance to edit connection_overview diagram:
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 or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)