Dochameleon
› Site Configuration

Site Configuration

Config File

website/
└── siteConfig.js

Site configurations are defined in website/siteConfig.js, here is an example:

const currentYear = new Date().getFullYear();

const siteConfig = {
  projectName: 'Dochameleon',
  title: 'Dochameleon',
  tagline: 'Open Source Documentation Site Generator',
  copyright: 'Copyright © ' + currentYear + ' Richard Zhang',

  rootUrl: 'https://richardzcode.github.io',
  baseUrl: '/Dochameleon',

  icon: 'img/dochameleon.png',
  favicon: 'img/favicon.png',

  css: [],
  js: [
    'https://buttons.github.io/buttons.js',
  ]
};

Dochameleon itself does not have css file. Theming is through CSS-in-JS. Extra css and js files can be specified in siteConfig.js

Header Links

website/components/headerLinks.json defines what displayed on main menu. Create this file to replace default header links.

Menu item types:

  • doc

  • blog

  • page

  • url

  • search

Example:

[
  { "type": "doc", "value": "guide_installation", "label": "Docs" },
  { "type": "page", "value": "help", "label": "Help" },
  { "type": "blog", "label": "Blog" },
  {
    "type": "page",
    "value": "languages",
    "img": "img/translation.svg",
    "label": "Languages"
  },
  {
    "type": "url",
    "value": "https://github.com/richardzcode/Dochameleon",
    "img": "img/github.png",
    "label": "GitHub"
  },
  { "type": "search" }
]
← Installation Site Creation →