Environment Reference

The DocsHub application supports a set of parameters in its .env file that helps you customize your documentation site.

documentationTitle

The title of your documentation site.

const defaultDocshubConfig: DocshubConfig = {
  documentationTitle: "Docshub Demo",
};

import.meta.env.DOCUMENTATION_TITLE

version

The version of your documentation site.

const defaultDocshubConfig: DocshubConfig = {
  version: "0.0.1",
};

import.meta.env.VERSION

docsUrl

The URL of your documentation site. If you don’t have a production URL, you can use http://localhost:4321 for testing.

const defaultDocshubConfig: DocshubConfig = {
  docsUrl: "https://docshub.vercel.app",
};

import.meta.env.DOCS_URL

faviconUrl

The main favicon URL of your documentation site.

const defaultDocshubConfig: DocshubConfig = {
  faviconUrl: {
    png:
      import.meta.env.FAVICON_URL ||
      "https://github.com/atmgrupomaggioli/docshub/blob/main/docshub/public/images/docshub_transparent.png?raw=true",
  },
};

faviconUrl accepts the following params:

• png: The URL of the PNG favicon.

import.meta.env.FAVICON_URL_PNG

• svg: The URL of the SVG favicon.

import.meta.env.FAVICON_URL_SVG

author (optional)

The author of your documentation site.

const defaultDocshubConfig: DocshubConfig = {
  author: "Author's name",
};

import.meta.env.AUTHOR

license (optional)

The license of your documentation site.

const defaultDocshubConfig: DocshubConfig = {
  license: "Proprietary",
};

import.meta.env.LICENSE

• The license can be one of the following:

type LicenseType =
  | "MIT"
  | "GPL-3.0"
  | "Apache-2.0"
  | "BSD-3-Clause"
  | "MPL-2.0"
  | "LGPL-3.0"
  | "AGPL-3.0"
  | "Unlicense"
  | "CC0-1.0"
  | "Proprietary";

logoUrl (optional)

The logo of your documentation site.

const defaultDocshubConfig: DocshubConfig = {
  logoUrl:
    "https://github.com/atmgrupomaggioli/docshub/blob/main/docshub/public/images/docshub_transparent.png?raw=true",
};

import.meta.env.LOGO_URL

repository (optional)

The repository of your documentation site.

const defaultDocshubConfig: DocshubConfig = {
  repository: {
    type: "GitHub",
    url: "https://github.com/atmgrupomaggioli/docshub",
  },
};

import.meta.env.REPOSITORY_TYPE
import.meta.env.REPOSITORY_URL

• repository.type (optional) can be one of the following:

type RepositoryType = "GitHub" | "GitLab" | "BitBucket";

• repository.url (required) is the URL of your repository.