vuepress web app Download - vuepress web app Source code download

vuepress web app

Website data

1.0.0

Download

Jingqing Xuan Villa

Web application built with VuePress: https://nice.lovejade.cn

Goals and Philosophy

The original intention of Jingqingxuan Villa was to experience VuePress : Vue-driven static website generator. VuePress consists of two parts: one is a minimalist static website generator that supports the development of themes with Vue , and the other is a default theme optimized for writing technical documents. It was originally created to support the documentation requirements of Vue and its subprojects.

Every page generated by VuePress comes with pre-rendered HTML, which also has very good loading performance and search engine optimization ( SEO ). At the same time, once the page is loaded, Vue will take over the static content and convert it into a complete single-page application ( SPA ), and other pages will only be loaded on demand when the user browses. In addition, it also has the following excellent features built into:

Built-in Markdown extension optimized for technical documentation
The ability to use Vue components in Markdown files
Vue-driven custom theme system
Automatically generate Service Worker
Google Analytics Integration
Multilingual support
The default theme includes:
- Responsive layout
- Optional homepage
- Concise out-of-the-box title search
- Algolia Search
- Customizable navigation bars and sidebars
- Automatically generated GitHub links and edit links for pages

Compared with Nuxt , Hexo , Jekyll , Docsify , GitBook and other tools, VuePress has huge advantages in different directions and is still developing and updating; if you have the need to build personal blogs and technical documents, then VuePress will be a great choice.

Additional features

Add comment function based on Github Issue (equivalent to built-in Gitalk ); just modify the comment field configuration in the .vuepress/themeConfig.js file; see Gitalk Options for the specific field meaning;
There is element-ui dependency to facilitate writing commonly used components; in this project, in addition to the comment component, there are also Advertisement , ArticleList , Contact , etc.;
Introduce prettier , lint-staged , husky and other dependencies to write more 'standard' markdown; inject it into Git hooks to ensure that your code base has a consistent style; even if you are working with the team to write, you don't have to worry about the issue of unified style!

How to use

You can Fork the project to your own code repository and run the following command:

 # ? clone the project
https://github.com/nicejade/vuepress-web-app.git
cd vuepress-web-app

# ➕ install dependencies & start dev
yarn && yarn start

Modify the "custom domain name" and "repository path" in the deploy.sh file, run the following command to achieve deployment (by default publishing to github pages ; if you do not use the custom domain name for the time being, just comment the line.