nathakits / pupilpress

Pupilpress

Testing Vuepress and building Pupil theme

Directory structure

pupilpress
├── docs
│   ├── .vuepress
│   │   ├── theme (Local theme)
│   │   │   ├── components
│   │   │   └── layouts
│   │   │   └── styles
│   │   │   └── util
│   │   │
│   │   ├── public
│   │   └── config.js
│   │
│   ├── README.md (Home page)
│   │
│   ├── products
│   │   └── README.md
│   ├── learn
│   │   └── README.md
│   ├── News
│   │   └── README.md
│   └── careers
│       └── README.md
│
└── package.json

Config

Header

In config.js file

module.exports = {
  title: '<header title>',
  description: '<description>',
  themeConfig: {
    nav: [
      { text: 'Name', link: '/name' },
      { text: 'Name', link: '/name' },
      { text: 'Name', link: '/name' },
      { text: 'Name', link: '/name' },
      { text: 'Name', link: '/name' },
    ],
    external: [
      { text: 'Name', link: 'https://<url>.com'},
    ]
  }
};

Homepage

Set the frontmatter in the README.md in docs folder

home: true
heroImage: '/img_path'
heroAlt: 'image alt description'
footer: 'footer description'