Skip to content

Commit bfdb827

Browse files
authored
website/docs: Update Docusaurus config. Prep for version picker. (#14401)
* website/docs: Clean up config. Add types. * website/docs: Format MDX. * website: Fix build warnings. Lint badges frontmatter.
1 parent 488a58e commit bfdb827

File tree

65 files changed

+1504
-1338
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+1504
-1338
lines changed

website/.prettierignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,3 @@ coverage
66
node_modules
77
help
88
static
9-
# TODO: Enable after monorepo formatting is cleaned up.
10-
**/*.md
11-
**/*.mdx

website/docs/add-secure-apps/flows-stages/stages/authenticator_email/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Email Authenticator Setup stage
3+
authentik_version: "2025.2"
34
---
45

5-
<span class="badge badge--version">authentik 2025.2+</span>
6-
76
This stage configures an email-based authenticator that sends a one-time code to a user's email address for authentication.
87

98
When a user goes through a flow that includes this stage, they are prompted for their email address (if not already set). The user then receives an email with a one-time code, which they enter into the authentik Login panel.

website/docs/add-secure-apps/flows-stages/stages/authenticator_webauthn/index.mdx

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
title: WebAuthn / Passkeys Authenticator setup stage
33
---
44

5-
<span class="badge badge--version">authentik 2021.3.1+</span>
6-
75
This stage configures a WebAuthn-based Authenticator. This can either be a browser, biometrics or a Security stick like a YubiKey.
86

97
### Options

website/docs/add-secure-apps/flows-stages/stages/email/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ You can also use custom email templates, to use your own design or layout.
2929
Starting with authentik 2024.2, it is possible to create `.txt` files with the same name as the `.html` template. If a matching `.txt` file exists, the email sent will be a multipart email with both the text and HTML template.
3030
:::
3131

32-
import Tabs from "@theme/Tabs";
3332
import TabItem from "@theme/TabItem";
33+
import Tabs from "@theme/Tabs";
3434

3535
<Tabs
3636
defaultValue="docker-compose"

website/docs/add-secure-apps/providers/proxy/server_caddy.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22
title: Caddy
33
---
44

5-
import Tabs from "@theme/Tabs";
65
import TabItem from "@theme/TabItem";
6+
import Tabs from "@theme/Tabs";
7+
78
import Placeholders from "./__placeholders.md";
89
import CaddyStandalone from "./_caddy_standalone.md";
910

website/docs/add-secure-apps/providers/proxy/server_envoy.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
title: Envoy
33
---
44

5-
import Tabs from "@theme/Tabs";
65
import TabItem from "@theme/TabItem";
6+
import Tabs from "@theme/Tabs";
7+
78
import Placeholders from "./__placeholders.md";
89
import EnvoyIstio from "./_envoy_istio.md";
910

10-
# Envoy
11-
1211
The configuration template shown below apply to both single-application and domain-level forward auth.
1312

1413
:::info

website/docs/add-secure-apps/providers/proxy/server_nginx.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import Tabs from "@theme/Tabs";
21
import TabItem from "@theme/TabItem";
2+
import Tabs from "@theme/Tabs";
33

44
# nginx
55

website/docs/add-secure-apps/providers/proxy/server_traefik.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
import Tabs from "@theme/Tabs";
21
import TabItem from "@theme/TabItem";
2+
import Tabs from "@theme/Tabs";
33

44
# Traefik
55

website/docs/customize/blueprints/v1/example.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ title: Example
44

55
This is one of the default packaged blueprints to create the default authentication flow.
66

7+
<!-- prettier-ignore-start -->
78
```yaml
89
version: 1
910
metadata:
@@ -64,3 +65,4 @@ entries:
6465
target: !KeyOf flow
6566
model: authentik_flows.flowstagebinding
6667
```
68+
<!-- prettier-ignore-end -->

website/docs/customize/blueprints/v1/tags.mdx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ Returns the value of the given environment variable. Can be used as a scalar wit
4848

4949
Examples:
5050

51+
{/* prettier-ignore-start */}
52+
5153
```yaml
5254
configure_flow: !Find [authentik_flows.flow, [slug, default-password-change]]
5355
```
@@ -60,17 +62,24 @@ configure_flow:
6062
]
6163
```
6264

65+
{/* prettier-ignore-end */}
66+
6367
Looks up any model and resolves to the the matches' primary key.
6468
First argument is the model to be queried, remaining arguments are expected to be pairs of key=value pairs to query for.
6569

6670
#### `!Context`
6771

6872
Example:
6973

74+
{/* prettier-ignore-start */}
75+
76+
7077
```yaml
7178
configure_flow: !Context foo
7279
```
7380

81+
{/* prettier-ignore-end */}
82+
7483
Find values from the context. Can optionally be called with a default like `!Context [foo, default-value]`.
7584

7685
#### `!Format`
@@ -209,6 +218,8 @@ For example, given a sequence like this - `["a", "b", "c"]`, this tag will resol
209218

210219
Minimal examples:
211220

221+
{/* prettier-ignore-start */}
222+
212223
```yaml
213224
configuration_stages: !Enumerate [
214225
!Context map_of_totp_stage_names_and_types,
@@ -224,6 +235,8 @@ configuration_stages: !Enumerate [
224235
]
225236
```
226237

238+
{/* prettier-ignore-end */}
239+
227240
The above example will resolve to something like this:
228241

229242
```yaml
@@ -265,6 +278,8 @@ Full example:
265278
Note that an `!Enumeration` tag's iterable can never be an `!Item` or `!Value` tag with a depth of `0`. Minimum depth allowed is `1`. This is because a depth of `0` refers to the `!Enumeration` tag the `!Item` or `!Value` tag is in, and an `!Enumeration` tag cannot iterate over itself.
266279
:::
267280

281+
{/* prettier-ignore-start */}
282+
268283
```yaml
269284
example: !Enumerate [
270285
!Context sequence, # ["foo", "bar"]
@@ -288,6 +303,8 @@ example: !Enumerate [
288303
]
289304
```
290305

306+
{/* prettier-ignore-end */}
307+
291308
The above example will resolve to something like this:
292309

293310
```yaml

0 commit comments

Comments
 (0)