@slashid/docusaurus-theme-slashid

Docusaurus SlashID Theme

SlashID theme to add authentication to Docusaurus.

---

Overview

The @slashid/docusaurus-theme-slashid package extends Docusaurus to add authentication to docusaurus. The theme can be combined with docusaurus openapi docs to preload API keys and API parameters directly through SlashID attributes.

Key Features:

• Compatible: Supports Magic Links, Passkeys, OTP via sms and SSO.
• Personalization: Allows to load per-user configuration data into docusaurus.

Installation

Theme:

yarn add @slashid/docusaurus-theme-slashid

Configuring docusaurus.config.js

Add the following to docusaurus.config.js to start using the theme:

// docusaurus.config.js

{
  ...

   themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      ...
      slashID: {
        orgID: "your slash id org id"
      },

  themes: ["@slashid/docusaurus-theme-slashid"],
}

Theme Configuration Options

The docusaurus-theme-slashid theme can be configured with the following options:

Name	Type	Default	Description
slashID.orgID	string	null	The SlashID organization ID.

Support

Please read SUPPORT.md for details on how to get support for this project.

Changelog

0.1.7 (Nov 8, 2022)

High level enhancements

• Auth can now be rendered server side
• Login is optional
• Added events to keep track of login state