+Actix Web currently has a minimum supported Rust version (MSRV) of { rustVersion }. Running rustup update will ensure you have the latest and greatest Rust version available. As such, this guide assumes you are running Rust { rustVersion } or later.
+
+Most importantly: Actix Web runs on Rust { rustVersion } or later and it works with stable releases. +
diff --git a/docusaurus.config.js b/docusaurus.config.js new file mode 100644 index 0000000..43a2d6e --- /dev/null +++ b/docusaurus.config.js @@ -0,0 +1,67 @@ +const path = require('path'); + +module.exports = { + title: 'Actix', + tagline: 'Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust', + url: 'https://actix.rs', + baseUrl: '/actix-website/', + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', + favicon: 'img/logo.png', + organizationName: 'actix', // Usually your GitHub org/user name. + projectName: 'actix-web', // Usually your repo name. + themeConfig: { + navbar: { + title: 'Actix', + logo: { + alt: 'Actix Logo', + src: 'img/logo.png', + }, + items: [ + { + to: 'docs', + activeBasePath: 'docs', + label: 'Documentation', + position: 'left', + }, + { + to: 'community', + activeBasePath: 'community', + label: 'Community', + position: 'left', + }, + { + to: 'code', + activeBasePath: 'code', + label: 'Code', + position: 'left', + }, + ], + }, + footer: { + copyright: `Copyright © ${new Date().getFullYear()} The Actix Team`, + }, + prism: { + // dracula is closest to docs.rs, where keywords are highlighted + theme: require('prism-react-renderer/themes/dracula'), + additionalLanguages: ['rust', 'toml'], + defaultLanguage: 'rust' + } + }, + plugins: ["docusaurus-plugin-sass"], + presets: [ + [ + '@docusaurus/preset-classic', + { + docs: { + sidebarPath: require.resolve('./sidebars.js'), + editUrl: + 'https://github.com/actix/actix-website/edit/master/', + }, + theme: { + customCss: require.resolve('./src/css/custom.css'), + }, + }, + ], + ], +}; diff --git a/examples/databases/src/main.rs b/examples/databases/src/main.rs index 6d50adf..cbb1952 100644 --- a/examples/databases/src/main.rs +++ b/examples/databases/src/main.rs @@ -57,7 +57,7 @@ async fn index(pool: web::Data
-
-
-
-
-404: Page Not Found
-What you were looking for was not here
-
-
-
-{{ partial "footer" . }}
diff --git a/layouts/code/baseof.html b/layouts/code/baseof.html
deleted file mode 100644
index 957e5a9..0000000
--- a/layouts/code/baseof.html
+++ /dev/null
@@ -1,23 +0,0 @@
-{{ partial "header" . }}
-{{ $currentURL := .RelPermalink }}
-
-
-
-
-
-
-
- Not Found
-We could not find the page you were looking for. This website was - recently restructured so maybe a link went dead. -
-
-
- Home page -
- Documentation -
-
-
-
-
-{{ .Title }}
- {{ if .Description }} -{{ .Description }}
- {{ end }} -
-
-
-{{ partial "footer" . }}
diff --git a/layouts/code/code.html b/layouts/code/code.html
deleted file mode 100644
index e0e8308..0000000
--- a/layouts/code/code.html
+++ /dev/null
@@ -1,3 +0,0 @@
-{{ define "main" }}
- {{ .Content }}
-{{ end }}
diff --git a/layouts/code/single.html b/layouts/code/single.html
deleted file mode 100644
index 5fb6c3f..0000000
--- a/layouts/code/single.html
+++ /dev/null
@@ -1,4 +0,0 @@
-{{ define "main" }}
-
-
-
-
-
- {{ block "main" . }}{{ end }}
-
- ↑ Back to code - {{ .Content }} -{{ end }} diff --git a/layouts/community/baseof.html b/layouts/community/baseof.html deleted file mode 100644 index 957e5a9..0000000 --- a/layouts/community/baseof.html +++ /dev/null @@ -1,23 +0,0 @@ -{{ partial "header" . }} -{{ $currentURL := .RelPermalink }} - -
-
-
-
-
-{{ .Title }}
- {{ if .Description }} -{{ .Description }}
- {{ end }} -
-
-
-{{ partial "footer" . }}
diff --git a/layouts/community/community.html b/layouts/community/community.html
deleted file mode 100644
index e0e8308..0000000
--- a/layouts/community/community.html
+++ /dev/null
@@ -1,3 +0,0 @@
-{{ define "main" }}
- {{ .Content }}
-{{ end }}
diff --git a/layouts/community/single.html b/layouts/community/single.html
deleted file mode 100644
index 07d833f..0000000
--- a/layouts/community/single.html
+++ /dev/null
@@ -1,4 +0,0 @@
-{{ define "main" }}
-
-
-
-
-
- {{ block "main" . }}{{ end }}
-
- ↑ Back to community - {{ .Content }} -{{ end }} diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html deleted file mode 100644 index a6203da..0000000 --- a/layouts/docs/baseof.html +++ /dev/null @@ -1,123 +0,0 @@ -{{ partial "header" . }} -{{ $currentURL := .RelPermalink }} - -
-
-
-
-
-{{ .Title }}
- {{ if .Description }} -{{ .Description }}
- {{ end }} -
-
-
-{{ partial "footer" . }}
diff --git a/layouts/docs/docs.html b/layouts/docs/docs.html
deleted file mode 100644
index e0e8308..0000000
--- a/layouts/docs/docs.html
+++ /dev/null
@@ -1,3 +0,0 @@
-{{ define "main" }}
- {{ .Content }}
-{{ end }}
diff --git a/layouts/docs/single.html b/layouts/docs/single.html
deleted file mode 100644
index e0e8308..0000000
--- a/layouts/docs/single.html
+++ /dev/null
@@ -1,3 +0,0 @@
-{{ define "main" }}
- {{ .Content }}
-{{ end }}
diff --git a/layouts/index.html b/layouts/index.html
deleted file mode 100644
index 981c161..0000000
--- a/layouts/index.html
+++ /dev/null
@@ -1,175 +0,0 @@
-{{ partial "header" . }}
-
-
-
-
-
-
-
-
-
-
-
-
-
- {{ block "main" . }}{{ end }}
-
-
- Edit on GitHub
-
-
- {{ if eq (len .Pages) 0 }}
- {{ .Scratch.Set "Docs" .Parent.Pages.ByWeight }}
- {{ else }}
- {{ .Scratch.Set "Docs" .Pages.ByWeight }}
- {{ end }}
-
- {{ .Scratch.Set "CurrentWeight" .Weight }}
-
- {{ range first 1 (where (.Scratch.Get "Docs") ".Weight" ">" (.Scratch.Get "CurrentWeight")) }}
- Next up: {{ .Title }}
- {{ end }}
-
-
-
-{{ partial "footer" . }}
diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html
deleted file mode 100644
index 5d7e70e..0000000
--- a/layouts/partials/footer.html
+++ /dev/null
@@ -1,19 +0,0 @@
-
-
-
-
-
-
-
- {{ template "_internal/google_analytics.html" . }}
-
-
-
-
- 
-
-
-
-
-
-
-
-
- - - Type Safe -
-Forget about stringly typed objects, from request to response, everything has types.
- -- - Feature Rich -
-- Out of the box logging, body compression, static file serving, TLS, HTTP/2, and - much more. -
- -- - Extensible -
-Easily create and share reusable components for any Actix Web application.
- -- - Blazingly Fast -
-Actix Web is blazingly fast. Don't take our word for it -- see for yourself!
-
-
-
- {{ highlight `use actix_web::{get, web, App, HttpServer, Responder};
-
-#[get("/hello/{name}")]
-async fn greet(name: web::Path) -> impl Responder {
- format!("Hello {name}!")
-}
-
-#[actix_web::main] // or #[tokio::main]
-async fn main() -> std::io::Result<()> {
- HttpServer::new(|| {
- App::new()
- .route("/hello", web::get().to(|| async { "Hello World!" }))
- .service(greet)
- })
- .bind(("127.0.0.1", 8080))?
- .run()
- .await
-}
-` "rust" "" }}
-
-
-
-
-
-
-
- {
- Ok("Hello World!")
-}` "rust" "" }}
-
- Flexible Responders
-
- Handler functions in Actix Web can return a wide range of objects that
- implement the Responder trait. This makes it a breeze
- to return consistent responses from your APIs.
-
- ,
-}
-
-async fn capture_event(evt: web::Json, db: web::Data) -> impl Responder {
- let new_event = db.store(&evt.kind, &evt.tags).await;
- format!("got event {}", new_event.id.unwrap())
-}` "rust" "" }}
-
- Powerful Extractors
-- Actix Web comes with a powerful extractor system that extracts parts of the incoming - HTTP request and passes it to your handler functions. -
-
- A handler function can receive up to 12 arguments that implement the
- FromRequest trait, in any order, and Actix Web will automatically extract
- them from the request and provide them. It feels like magic!
-
- ) -> impl Responder {
- format!("Hello {} from {}!", form.username, form.country)
-}
-
-// register form can be either JSON or URL-encoded
-async fn register(form: Either, Form>) -> impl Responder {
- let Register { username, country } = form.into_inner();
- format!("Hello {username} from {country}!")
-}` "rust" "" }}
-
- Easy Form Handling
-- Handling multipart/urlencoded form data is easy. Just define a structure that can be - deserialized and Actix Web will handle the rest. -
- {{ highlight `use actix_web::web::{Either, Json, Form}; - -#[derive(Deserialize)] -struct Register { - username: String, - country: String, -} - -// register form is JSON -async fn register(form: web::Json
- ) -> impl Responder {
- format!("Hello {}!", &path)
-}
-
-let app = App::new()
- .service(index)
- .route("/{name}", web::get().to(hello));
-` "rust" "" }}
-
- Request Routing
-- The built-in Actix Web request router can be used with or without macros attached to - handlers, and always provides flexible and composable methods of creating routing - tables. -
-- Includes support for matching dynamic path segments, path prefix groups, and custom - routing guards which let you define your own rules. -
- {{ highlight `#[get("/")] -async fn index(_req: HttpRequest) -> impl Responder { - "Hello from the index page!" -} - -async fn hello(path: web::Path