Vuepress Theme OneN

Overview

The oneN theme is a minimalist blog theme inspired by the oneNote notebook. It aims to create a simple and clean document-style blog, removing elements such as tags and archives often seen in mainstream blog themes. It is built with VuePress and provides features such as homepage layout, sidebar navigation, customizable header, background music, custom footer, and markdown extensions for metadata and references.

Features

• Homepage: Provides a layout for a homepage. Specify home: true in the YAML front matter of the root-level README.md file to use it.
• Sidebar: A core component of the oneN theme, it supports three-level navigation and requires configuration of paths for first and second-level navigation.
• Header: The navigation bar includes an avatar, search box, and option links. Configure it using the themeConfig.navbar field.
• Background Music: Added in version 1.1.1, the theme allows adding background music by adding the music field in the config.js file. The music can be a static resource or a reference to an external link.
• Footer: Supports custom name and icons. Configure it in the config.js file using the themeConfig.footer field.
• Custom Icons: Utilizes the ant-design-vue icon library, enabling customization of icons in the navbar and footer by changing the title property.
• Custom Colors: Create a palette.styl file in the .vuepress/styles/ directory to apply simple color replacements or define color variables.
• Markdown Extensions: VuePress provides built-in support for YAML front matter, allowing the addition of fields in each .md file. This can be used for metadata and references.

Summary

The oneN theme is a simple and clean blog theme inspired by oneNote. It offers features such as a homepage layout, sidebar navigation, customizable header and footer, background music, and support for metadata and references in Markdown files. By following the installation guide and configuring the theme, users can create a stylish and minimalistic blog with ease.