website: Copy files during build. website: Allow for mixed env builds. website: Reduce build size. website: Expose build. website: Add build memory debugging. WIP: Disable broken links check to compare memory usage. website: Update deps. website: Clean up API paths. website: Flesh out 3.8 fixes. Format. website: Update ignore paths. Website: Clean up integrations build. website: Fix paths. website: Optimize remark. website: Update deps. website: Format. website: Remove linking. website: Fix paths. wip: Attempt API only build. Prep. Migrate render to runtime. Tidy sidebar. Clean up templates. docs: Move directory. WIP docs: Flesh out split. website: Fix issue where routes have collisions.
827 B
827 B
title, sidebar_label, tags
| title | sidebar_label | tags | ||||
|---|---|---|---|---|---|---|
| Docs development environment | Docs development |
|
If you want to only make changes to the documentation, you only need Node.js.
Prerequisites
- Node.js (any recent version should work; we use 24.x to build)
- Make (again, any recent version should work)
:::info
Depending on platform, some native dependencies might be required. On macOS, run brew install node@24
:::
Instructions
- Clone the git repo from https://github.com/goauthentik/authentik
- Run
make docs-installto install the docs development dependencies - Run
make docs-watchto start a development server to see and preview your changes - Finally when you're about to commit your changes, run
make docsto run the linter and auto-formatter.