Build your own theme

Build your own theme by changing the templates or CSS.


The easiest way to install all dependencies is with mise.

  1. Create a local copy of the repository.

  2. Install the dependencies.

    mise install
    
  3. Test, if everything is working.

    hatch run dev:all
    

    This runs tests and the linter.

    Too see a list of available tasks, run:

    hatch env show
    
  4. Install JavaScript dependencies.

    Go to the src/theme-src directory and run:

    pnpm install
    
  5. To build the JavaScript and CSS assets, run:

    pnpm build
    
  6. Optional: add DocSearch environment variables.

    If you have access to the environment variables for DocSearch, copy the file docs/.env.example to docs/.env and fill in the values. They’re safe to expose on your website.

    By default, placeholder values are used and DocSerach won’t work when developing locally.

If you don’t want to use mise, use your preferred version and package managers. See the files mise.toml, pyproject.toml, and src/theme-src/package.json for more information.

Now you can make any change you want.