PressVue

Config Settings

Add site wide settings from .vuepress/config.js or just hear from the 🐴👅 VuePres - config reference.

module.exports = {
  // Settings
}

Basic Site Info

title: "Kooll Pname", // Site Header
description: "Etc. etc. etc.",

HTML <head>

head: [
  //Favicon
  ['link', { rel: 'icon', href: `/logo.png` }] // .vuepress/public/logo.png
],

search: false,
searchMaxSuggestions: 10

Theme Configuration

themeConfig: {
  // Nav, Sidebar, Locales (for country specific themeconfig)
}

# This Site
cwd
└─ docs
│   │─ README.md
│   │─ test.md
│   └─ help
│      └─ config
│      │  └─ README.md
│      │─ markdown
│      │  └─ README.md
│      │─ vue
│      │  └─ README.md

Simple

nav: [

  // Simple
  {
    text: 'Nav',
    link: '/test.md'
  },

  // Dropdown
  {text: 'Dropdown',
      items: [
        { text: 'Label',
          items: [
            { text: 'One', link: '/test.md' },
            { text: 'Two', link: '/test.md' }
          ]
      }
    ]
  },
  {text: 'Help',
    items: [
      { text: '',
        items: [
          { text: 'Markdown', link: '/help/markdown/' },
          { text: 'Vue', link: '/help/vue/' }
        ]
      }
    ]
  },

  // External Link
  {
    text: 'Github',
    link: 'https://github.com/'
  }

]

Displaying Header Links of All Pages

displayAllHeaders: true // Default: false

Basic

[
  '/',
  ['/test', 'custom text'],
  ['/custompg', 'Dark Mode'],
  '/help/vue/',
  '/help/markdown/'
],

Groups

[
  {
    title: 'Main',
    collapsable: false,
    children: [
      '/',
      '/config'
    ]
  },
  {
    title: 'Help',
    children: [
        '/help/vue/',
        '/help/markdown/'
     ]
  },
  {
    title: 'All',
    children: [
        '/',
        '/test',
        '/help/vue/',
        '/help/markdown/'
     ]
  }
]

Page Specific

{

  '/help/': [
    {
    // Collapsable
      title: 'Help',
      collapsable: true,
      children: [
        '/help/vue/',
        '/help/markdown/'
        ]
    }
  ],

  '/': [
    '/',
    '/test',
  ]

}

From an object

{'/': genSidebarConfig('Pages')}
Object
function genSidebarConfig (title) {

  // You should put this outisde of module.exports
  return [
    {
      title,
      collapsable: true,
      children: [
        '',
        '/test',
        '/help/vue/',
        '/help/markdown/'
      ]
    }
  ]
}

This will crawl through your entire site. The default search only looks through headings.

algolia: {
  apiKey: <APIKEY>,
  indexName: '<NAME>'
},

Service Worker

serviceWorker: true

Translations

locales: {
  '/': {lang: 'en-US' },
  '/zh/': {lang: 'en-JP' }
}

← Using Markdown →