current position:Home>How to build component library documents
How to build component library documents
2021-08-27 10:07:24 【Egypt】
Preface
When we finish developing a component library , You need a component description document , The document page is the most direct window for obtaining information . Document pages generally contain this information :
- Description of the component
- Components Demo Demonstration of examples 、 Description and source code
- Parameter document of the component
Component documentation is the key to letting others know about the component library , Including the scope of application of component library (pc End , Mobile , Lightweight or heavyweight ), Compatible browser version , Design principles and background , And community ecology , Usage, etc .
About how to develop component libraries , Look at this :
Document generation
It's recommended here vuepress , Can help us quickly complete the construction of component library documents .(vuepress.vuejs.org/zh/guide/)
vuepress Is a document generation tool , Default style and vue The official documents are almost identical , Because it was created for vue Document support with related subprojects . It has... Built in Markdown An extension of , It's used when writing documents markdown To write , The most worry is that you can directly in Markdown Use... In the document Vue Components , It means that every component written in our component library , It can be used directly in the document , Show the actual running effect of the component . My case website is through vuepress To write it , After generating a static website , use gh-pages Deploy directly to github On , It can also be deployed directly to our own website .
vuepress Better yet, you can customize it webpack Configuration and themes , It means that you can make your own document site have more functional features during the development phase , At the same time, you can change the site style to your own theme style . There's no need for us to start over , For the requirement that we want to quickly complete the document construction of component library , It's still quite effective .
VuePress Building documents
VuePress yes Vue Static website generator driven . Support in Markdown Use in Vue Components , concise , High performance . Of course, you can also use other document generators , Such as Docz、Storybook etc. .
You can learn how to use... According to the official documents :www.vuepress.cn/guide/getti…
Project generation and configuration
install
You can right-click to manually create , You can also use mkdir Command NEW :
mkdir heavenUi && cd heavenUi
Copy code
Global installation VuePress
npm install -g vuepress
Copy code
Get into vuepressBlogDemo Folder , Initialize project
Use npm init or npm init -y( Default yes)
npm init -y
Copy code
To configure scripts
package.json
{
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
Copy code
initialization docs
Create directories and files as shown in the following figure
VuePress follow “ Convention over configuration ” Principles , The recommended directory structure is as follows :
.
├── docs
│ ├── .vuepress ( Optional )
│ │ ├── components ( Optional )
│ │ ├── theme ( Optional )
│ │ │ └── Layout.vue
│ │ ├── public ( Optional )
│ │ ├── styles ( Optional )
│ │ │ ├── index.styl
│ │ │ └── palette.styl
│ │ ├── templates ( Optional , Be careful with your configuration )
│ │ │ ├── dev.html
│ │ │ └── ssr.html
│ │ ├── config.js ( Optional )
│ │ └── enhanceApp.js ( Optional )
│ │
│ ├── README.md
│ ├── guide
│ │ └── README.md
│ └── config.md
│
└── package.json
Copy code
Be careful
Please note the capitalization of the directory name .
- docs/.vuepress: For storing global configuration 、 Components 、 Static resources, etc .
- docs/.vuepress/components: In this catalog Vue Components will be automatically registered as global components .
- docs/.vuepress/theme: For storing local themes .
- docs/.vuepress/styles: Used to store style related documents .
- docs/.vuepress/styles/index.styl: Global style files that will be automatically applied , Will be generated in the final CSS End of file , Has a higher priority than the default style .
- docs/.vuepress/styles/palette.styl: Used to override the default color constant , Or set up a new stylus Color constant .
- docs/.vuepress/public: Static resource directory .
- docs/.vuepress/templates: Storage HTML Template file .
- docs/.vuepress/templates/dev.html: For the development environment HTML Template file .
- docs/.vuepress/templates/ssr.html: Build on Vue SSR Of HTML Template file .
- docs/.vuepress/config.js: The entry file for the configuration file , It can also be YML or toml.
- docs/.vuepress/enhanceApp.js: Client application enhancements .
Home page information settings
---
home: true
actionText: Start using
# Website portal Configure the path according to your home page
actionLink: /component/installation
features:
- title: heaven-UI
details: A set of based on Vue.js The high quality of UI Component library
footer: MIT Licensed | COPYRIGHT
---
Copy code
The effect of the home page is as follows
Configure navigation
module.exports = {
title: 'Heaven', // Set site title
description: ' Light weight 、 reliable Vue Component library ', // describe
dest: './dist', // Set output directory
themeConfig: { // Theme configuration
nav: [ // Head navigation bar
{
text: ' Home page ',
link: '/'
},
{
text: " Components ",
link: "/component/installation",
},
],
// Add sidebar for the following routes
sidebar: {
'/components/': [
{
title: ' Components ',
collapsable: false,
children: [
'button',
// ... Other components
]
},
// Other settings
]
}
}
}
Copy code
Enhancement files for client applications
enhanceApp.js
This file is used to add components Demo Show the optimized configuration
install
npm install heaven-ui less less-loader --save
Copy code
If local debugging is required , can link Developed component library heaven-ui
npm link heaven-ui
Copy code
.vuepress/enhanceApp.js
/**
* Expand VuePress application
*/
import Heaven from 'heaven-ui'
import 'heaven-ui/lib/heaven-ui.min.css'
export default ({
Vue, // VuePress In use Vue Constructors
options, // Some options attached to the root instance
router, // Routing instance of current application
siteData // Site metadata
}) => {
// ... Do some other application level optimizations
Vue.use(Heaven)
}
Copy code
.vuepress/components/button.vue Files can be button Component's Demo Display style
stay md Added in document You can render directly button.vue The content of
<template>
<div>
<h-button> Default button </h-button>
<h-button type="primary"> Main buttons </h-button>
<h-button type="success"> Success button </h-button>
<h-button type="warning"> Warning button </h-button>
<h-button type="danger"> Danger button </h-button>
<h-button type="info"> Information buttons </h-button>
</div>
</template>
<script>
export default {
}
</script>
<style>
</style>
Copy code
Write the corresponding component Markdown file
#### Button Button
#### Common operation button .
<ClientOnly>
<button></button>
</ClientOnly>
``` html
<template>
<h-button> Default button </h-button>
<h-button type="primary"> Main buttons </h-button>
<h-button type="success"> Success button </h-button>
<h-button type="warning"> Warning button </h-button>
<h-button type="danger"> Danger button </h-button>
<h-button type="info"> Information buttons </h-button>
</template>
```
Copy code
The effect is as follows
visit http://localhost:8080 You can see the document . Of course , You can deploy documents to your own server , It can also be deployed to Github pages On .
Summary
thus , The documentation of the component library is set up , You can supplement the documents later .
copyright notice
author[Egypt],Please bring the original link to reprint, thank you.
https://en.qdmana.com/2021/08/20210827100720102U.html
The sidebar is recommended
- Crazy blessing! Tencent boss's "million JVM learning notes", real topic of Huawei Java interview 2020-2021
- JS JavaScript how to get the subscript of a value in the array
- How to implement injection in vuex source code?
- JQuery operation select (value, setting, selected)
- One line of code teaches you how to advertise on Tanabata Valentine's Day - Animation 3D photo album (music + text) HTML + CSS + JavaScript
- An article disassembles the pyramid architecture behind the gamefi outbreak
- BEM - a front-end CSS naming methodology
- [vue3] encapsulate custom global plug-ins
- Error using swiper plug-in in Vue
- Another ruthless character fell by 40000, which was "more beautiful" than Passat and maiteng, and didn't lose BMW
guess what you like
-
Huang Lei basks in Zhang Yixing's album, and the relationship between teachers and apprentices is no less than that in the past. Netizens envy Huang Lei
-
He was cheated by Wang Xiaofei and Li Chengxuan successively. Is an Yixuan a blessed daughter and not a blessed home?
-
Zhou Shen sang the theme song of the film "summer friends and sunny days" in mainland China. Netizen: endless aftertaste
-
Pink is Wangyuan online! Back to the peak! The new hairstyle is creamy and sassy
-
Front end interview daily 3 + 1 - day 858
-
Spring Webflux tutorial: how to build reactive web applications
-
[golang] walk into go language lesson 24 TCP high-level operation
-
August 23, 2021 Daily: less than three years after its establishment, Google dissolved the health department
-
The female doctor of Southeast University is no less beautiful than the female star. She has been married four times, and her personal experience has been controversial
-
There are many potential safety hazards in Chinese restaurant. The top of the program recording shed collapses, and the artist will fall down if he is careless
Random recommended
- Anti Mafia storm: He Yun's helpless son, Sun Xing, is destined to be caught by his dry son
- Introduction to flex flexible layout in CSS -- learning notes
- CSS learning notes - Flex layout (Ruan Yifeng tutorial summary)
- Today, let's talk about the arrow function of ES6
- Some thoughts on small program development
- Talk about mobile terminal adaptation
- Unwilling to cooperate with Wang Yibo again, Zhao Liying's fans went on a collective strike and made a public apology in less than a day
- JS function scope, closure, let, const
- Zheng Shuang's 30th birthday is deserted. Chen Jia has been sending blessings for ten years. Is it really just forgetting to make friends?
- Unveil the mystery of ascension
- Asynchronous solution async await
- Analysis and expansion of Vue infinite scroll source code
- Compression webpack plugin first screen loading optimization
- Specific usage of vue3 video play plug-in
- "The story of huiyeji" -- people are always greedy, and fairies should be spotless!
- Installing Vue devtool for chrome and Firefox
- Basic usage of JS object
- 1. JavaScript variable promotion mechanism
- Two easy-to-use animation JS that make the page move
- Front end Engineering - scaffold
- Java SQL Server intelligent fixed asset management, back end + front end + mobile end
- Mediator pattern of JavaScript Design Pattern
- Array de duplication problem solution - Nan recognition problem
- New choice for app development: building mobile applications using Vue native
- New gs8 Chengdu auto show announces interior Toyota technology blessing
- Vieira officially terminated his contract and left the team. The national security club sent blessings to him
- Less than 200000 to buy a Ford RV? 2.0T gasoline / diesel power, horizontal bed / longitudinal bed layout can be selected
- How does "heart 4" come to an end? Pinhole was boycotted by the brand, Ma Dong deleted the bad comments, and no one blessed him
- We are fearless in epidemic prevention and control -- pay tribute to the front-line workers of epidemic prevention!
- Front end, netty framework tutorial
- Xiaomi 11 | miui12.5 | android11 solves the problem that the httpcanary certificate cannot be installed
- The wireless charging of SAIC Roewe rx5 plus is so easy to use!
- Upload and preview pictures with JavaScript, and summarize the most complete mybatis core configuration file
- [25] typescript
- CSS transform Complete Guide (Second Edition) flight.archives 007
- Ajax foundation - HTTP foundation of interview essential knowledge
- Cloud lesson | explain in detail how Huawei cloud exclusive load balancing charges
- Decorator pattern of JavaScript Design Pattern
- [JS] 10. Closure application (loop processing)
- Left hand IRR, right hand NPV, master the password of getting rich