Notes Vuepress
使用VuePress构建静态网站 https://github.com/bajins/bajins.github.io ，动态构建 https://github.com/bajins/notes-docsify
Overview:
This article provides information on how to quickly create a personalized documentation website using the repository. It also highlights the support for syntax highlighting using PrismJS Shiki. Additionally, it mentions the automatic configuration of the menu bar and sidebar during compilation, allowing for a maximum of three levels of directory structure. The article also mentions the availability of various open-source VuePress themes contributed by enthusiastic developers. For those who find VuePress or VitePress inconvenient, the article suggests using the static blog writing client called Gridea. It emphasizes the importance of following the official standard directory structure for making modifications to the documentation.
Features:
- Fast creation of personal documentation website: This repository allows for the quick creation of a customized documentation website.
- Support for syntax highlighting: The use of PrismJS Shiki enables syntax highlighting in the documentation.
- Automatic configuration of menu bar and sidebar: During compilation, the theme automatically configures the menu bar and sidebar.
- Three-level directory structure: The theme supports a maximum of three levels of directory structure.
- Wide selection of open-source themes: The VuePress community offers a variety of open-source themes for users to choose from.
- Compatibility with Gridea: Users can opt to use the static blog writing client called Gridea as an alternative to VuePress or VitePress.
- Standard directory structure: Following the official directory structure ensures smooth modification of the documentation.
- Vue
Vue.js is a lightweight and flexible JavaScript framework that allows developers to easily build dynamic and reactive user interfaces. Its intuitive syntax, modular architecture, and focus on performance make it a popular choice for modern web development.
- Vuepress
VuePress is a minimalistic static site generator based on Vue.js that allows developers to create fast, SEO-friendly, and customizable documentation websites.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Blog
Blog websites feature posts written by one or more authors, organized by categories and tags, with a section for comments and archives sorted by date or topic. Additional features may include search bar, social media sharing, subscription or RSS feed, about and contact pages, and visual content.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
