Titanium Docs DevKit

# Titanium Theme Config

TIP

This theme supports all options (opens new window) of the VuePress default theme.

An additional sidebar to the right with the first two level of headers (h2 and h3) of the current page can be displayed by setting the contentSidebar option in a page's frontmatter (opens new window).

---
contentSidebar: true
sidebarDepth: 0
---

This is especially usefull when you already have a lot of content in the main sidebar and can help to avoid overloading it with too many items. You may need to adjust the sidebarDepth for the main sidebar to prevent showing the page headers there as well.

TIP

A demo of the sidebar can be seen on this page.

The title of the sidebar can be configured via contentSidebarTitle. If not set it defaults to "Contents".

// .vuepress/config.js
module.exports = {
  themeConfig: {
    contentSidebarTitle: 'On this page'
  }
}

Providing one of the themeConfig.footer* options will enable the globally shown footer at the bottom of every page.

// .vuepress/config.js
module.exports = {
  themeConfig: {
    // Sets the copyright message
    footerCopyright: 'Copyright © 2019-present Axway Appcelerator',
    // Shows a logo in the footer between the sitemap and copyright message
    footerLogo: '/axway-appcelerator-logo.png',
    // Change the URL the footer logo will point to. Defaults to '/'
    footerLogoLink: '/guide'
    // Sitemap for quick access to different pages (can be internal or external)
    footerSitemap: {
      'Docs': [
        { text: 'Alloy', link: 'https://docs.appcelerator.com/' }
      ]
    }
  }
}

# Versioning

You can change the name of the next version in the version dropdown via nextVersionTitle

// .vuepress/config.js
module.exports = {
  themeConfig: {
    nextVersionTitle: 'develop'
  }
}

You can also change the paths for edit links of versioned docs and unversioned pages to match the versionedSourceDir and pagesSourceDir option of the versioning plugin.

module.exports = {
  themeConfig: {
    // defaults to 'website/versioned_docs'
    docsDirVersioned: 'path/to/versioned_docs',
    // defaults to 'website/pages'
    docsDirPages: 'path/to/pages'
  }
}

←

Contents