Skip to content

Commit

Permalink
New: vuepress:基于Vue的简约静态站点生成器
Browse files Browse the repository at this point in the history
  • Loading branch information
qiilee committed Nov 20, 2018
1 parent def213d commit 3b56a5a
Show file tree
Hide file tree
Showing 445 changed files with 32,559 additions and 0 deletions.
9 changes: 9 additions & 0 deletions vuepress/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
10 changes: 10 additions & 0 deletions vuepress/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
module.exports = {
root: true,
extends: [
'plugin:vue-libs/recommended',
'plugin:jest/recommended'
],
rules: {
indent: ['error', 2, { MemberExpression: 'off' }]
}
}
41 changes: 41 additions & 0 deletions vuepress/.github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: Bug report
about: Create a report to help us improve

---

<!-- Please don't delete this template or we'll close your issue -->
<!-- Before creating an issue please make sure you are using the latest version of VuePress. -->

<!-- Please confirm you will submit an issue. -->
<!-- Issues which contain questions or support requests will be closed. -->
<!-- (Update "[ ]" to "[x]" to check a box) -->

- [ ] I confirm that this is a issue rather than a question.

<!-- Please ask questions via following several ways. -->
<!-- https://vue-land.js.org/ -->
<!-- https://forum.vuejs.org/ -->
<!-- https://stackoverflow.com/questions/ask?tags=vuepress -->

## Bug report

#### Version

#### Steps to reproduce

<!-- If you are reporting a bug that can ONLY be reproduced on your repository, PLEASE provide this repo link. That takes guessing work out of the way and saves us time. -->

<!-- If your repo isn't public, you can use this boilerplate to create a proper reproduction repo quickly: https://github.com/ulivz/template-vuepress -->

#### What is expected?

#### What is actually happening?

#### Other relevant information

- Your OS:
- Node.js version:
- Browser version:
- Is this a global or local install?
- Which package manager did you use for the install?
22 changes: 22 additions & 0 deletions vuepress/.github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project

---

<!-- Please don't delete this template or we'll close your issue -->
<!-- Before creating an issue please make sure you are using the latest version of VuePress. -->

## Feature request

<!-- Please ask questions on StackOverflow. -->
<!-- https://stackoverflow.com/questions/ask?tags=vuepress -->
<!-- Issues which contain questions or support requests will be closed. -->

#### What problem does this feature solve?

#### What does the proposed API look like?

#### How should this be implemented in your opinion?

#### Are you willing to work on this yourself?**
47 changes: 47 additions & 0 deletions vuepress/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!-- Please don't delete this template -->

<!-- PULL REQUEST TEMPLATE -->
<!-- (Update "[ ]" to "[x]" to check a box) -->

**Summary**

**What kind of change does this PR introduce?** (check at least one)

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update
- [ ] Refactor
- [ ] Docs
- [ ] Build-related changes
- [ ] Other, please describe:

If changing the UI of default theme, please provide the **before/after** screenshot:

**Does this PR introduce a breaking change?** (check one)

- [ ] Yes
- [ ] No

If yes, please describe the impact and migration path for existing applications:

**The PR fulfills these requirements:**

- [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. `fix #xxx[,#xxx]`, where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

- [ ] Chrome
- [ ] Firefox
- [ ] Safari
- [ ] Edge
- [ ] IE

If adding a **new feature**, the PR's description includes:

- [ ] A convincing reason for adding this feature
- [ ] Related documents have been updated
- [ ] Related tests have been updated

To avoid wasting your time, it's best to open a **feature request issue** first and wait for approval before working on it.

**Other information:**
6 changes: 6 additions & 0 deletions vuepress/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.DS_Store
node_modules
*.log
.temp
TODOs.md
vuepress
18 changes: 18 additions & 0 deletions vuepress/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Basic
*.log
.temp
vuepress
art
docs
.eslintrc.js
yarn.lock
TODOs.md
.github
.idea

# CI related
scripts

# Test related
test
.babelrc
607 changes: 607 additions & 0 deletions vuepress/CHANGELOG.md

Large diffs are not rendered by default.

21 changes: 21 additions & 0 deletions vuepress/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018-present, Yuxi (Evan) You

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
109 changes: 109 additions & 0 deletions vuepress/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
<p align="center">
<a href="https://vuepress.vuejs.org/" target="_blank">
<img width="280" src="https://raw.githubusercontent.com/vuejs/vuepress/master/packages/docs/docs/.vuepress/public/hero.png" alt="logo">
</a>
</p>

<p align="center">
<a href="https://npmcharts.com/compare/vuepress?minimal=true"><img src="https://img.shields.io/npm/dm/vuepress.svg" alt="Downloads"></a>
<a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/v/vuepress.svg" alt="Version"></a>
<a href="https://www.npmjs.com/package/vuepress"><img src="https://badgen.net/npm/v/vuepress/next" alt="npm next version"></a>
<a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/l/vuepress.svg" alt="License"></a>
<a href="https://discordapp.com/invite/HBherRA"><img src="https://img.shields.io/badge/Discord-join%20chat-738bd7.svg" alt="vuepress channel on Discord"></a>
</p>

> This is the branch for `VuePress Next`.
## Status: alpha

Certain combinations of plugins may not work properly, and things may change or break until we reach `beta` phase. Do not use in production yet unless you are adventurous.

For 0.x, it's moved to [0.x branch](https://github.com/vuejs/vuepress/tree/0.x) and still maintained, the website was switching to https://v0.vuepress.vuejs.org.

> Note that we are working hard to improve the documentation and contributions welcome if you keep up with the latest changes.
# VuePress

> Minimalistic docs generator with Vue component based layout system
https://vuepress.vuejs.org/

## Install

```bash
yarn add vuepress -D # Install 0.x.x.
yarn add vuepress@next -D # Install next.
```

## Features

**Built-in markdown extensions**

* [Table of Contents](https://vuepress.vuejs.org/guide/markdown.html#table-of-contents)
* [Custom Containers](https://vuepress.vuejs.org/guide/markdown.html#custom-containers)
* [Line Highlighting](https://vuepress.vuejs.org/guide/markdown.html#line-highlighting-in-code-blocks)
* [Line Numbers](https://vuepress.vuejs.org/guide/markdown.html#line-numbers)
* [Import Code Snippets](https://vuepress.vuejs.org/guide/markdown.html#import-code-snippets)

**Using Vue in Markdown**

* [Templating](https://vuepress.vuejs.org/guide/using-vue.html#templating)
* [Using Components](https://vuepress.vuejs.org/guide/using-vue.html#using-components)

**Vue-powered custom theme system**

* [Metadata](https://vuepress.vuejs.org/guide/custom-themes.html#site-and-page-metadata)
* [Content Excerpt](https://vuepress.vuejs.org/guide/custom-themes.html#content-excerpt)

**Default theme**

* Responsive layout
* [Optional Homepage](https://vuepress.vuejs.org/default-theme-config/#homepage)
* [Simple out-of-the-box header-based search](https://vuepress.vuejs.org/default-theme-config/#built-in-search)
* [Algolia Search](https://vuepress.vuejs.org/default-theme-config/#algolia-search)
* Customizable [navbar](https://vuepress.vuejs.org/default-theme-config/#navbar) and [sidebar](https://vuepress.vuejs.org/default-theme-config/#sidebar)
* [Auto-generated GitHub link and page edit links](https://vuepress.vuejs.org/default-theme-config/#git-repo-and-edit-links)
* [PWA: Popup UI to refresh contents](https://vuepress.vuejs.org/default-theme-config/#popup-ui-to-refresh-contents)
* [Last Updated](https://vuepress.vuejs.org/default-theme-config/#last-updated)

**Miscellaneous**

* [Multi-Language Support](https://vuepress.vuejs.org/guide/i18n.html)
* [Service Worker](https://vuepress.vuejs.org/config/#serviceworker)
* [Google Analytics](https://vuepress.vuejs.org/config/#ga)

## Showcase

Websites built with VuePress:

**Vue Ecosystem**

* [vue-cli](https://cli.vuejs.org/)
* [vuex](https://vuex.vuejs.org/)
* [vue-server-renderer](https://ssr.vuejs.org/)
* [vue-router](https://router.vuejs.org/)
* [vue-test-utils](https://vue-test-utils.vuejs.org/)
* [vue-loader](https://vue-loader.vuejs.org/)
* [vetur](https://vuejs.github.io/vetur/)
* [rollup-plugin-vue](https://rollup-plugin-vue.vuejs.org/)

**Community**

* [cr-vue](https://cr-vue.mio3io.com/)
* [vuesax](https://lusaxweb.github.io/vuesax/)
* [vuemeetups](https://vuemeetups.org)


## Development

> Please make sure your version of Node.js is greater than 8.
``` bash
yarn
yarn dev # serves VuePress' own docs with itself
yarn test # make sure your code change pass the test
```

## License

[MIT](https://github.com/vuejs/vuepress/blob/master/LICENSE)
1 change: 1 addition & 0 deletions vuepress/__mocks__/@org/vuepress-plugin-a.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {}
1 change: 1 addition & 0 deletions vuepress/__mocks__/@org/vuepress-plugin-b.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {}
1 change: 1 addition & 0 deletions vuepress/__mocks__/@org/vuepress-theme-a/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {}
1 change: 1 addition & 0 deletions vuepress/__mocks__/@vuepress/plugin-a.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {}
1 change: 1 addition & 0 deletions vuepress/__mocks__/@vuepress/theme-a/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {}
1 change: 1 addition & 0 deletions vuepress/__mocks__/vuepress-plugin-a.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {}
3 changes: 3 additions & 0 deletions vuepress/__mocks__/vuepress-plugin-b.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
multiple: true
}
1 change: 1 addition & 0 deletions vuepress/__mocks__/vuepress-theme-a/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = {}
Binary file added vuepress/art/hero.psd
Binary file not shown.
9 changes: 9 additions & 0 deletions vuepress/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module.exports = {
'env': {
'test': {
'presets': [
['@babel/preset-env', { 'targets': { 'node': 'current' }}]
]
}
}
}
6 changes: 6 additions & 0 deletions vuepress/lerna.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"lerna": "2.5.1",
"npmClient": "yarn",
"useWorkspaces": true,
"version": "1.0.0-alpha.23"
}
42 changes: 42 additions & 0 deletions vuepress/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"private": true,
"workspaces": [
"packages/@vuepress/*",
"packages/vuepress",
"packages/docs",
"packages/blog"
],
"description": "Minimalistic doc generator with Vue component based layout system",
"scripts": {
"boot": "node scripts/bootstrap.js",
"dev": "yarn workspace docs dev",
"build": "yarn workspace docs build",
"dev:blog": "yarn workspace blog dev",
"build:blog": "yarn workspace blog build",
"lint": "eslint --fix packages/**/*.js packages/**/*.vue packages/**/bin/*",
"release": "yarn --pure-lockfile && node scripts/release.js",
"changelog": "node scripts/genChangelog.js run",
"test": "node scripts/test.js"
},
"gitHooks": {
"pre-commit": "lint-staged"
},
"lint-staged": {
"*.{js,vue}": [
"eslint --fix",
"git add"
]
},
"devDependencies": {
"conventional-changelog-cli": "^1.3.22",
"eslint": "^4.19.1",
"eslint-plugin-jest": "^21.15.1",
"eslint-plugin-vue-libs": "^3.0.0",
"lerna": "^2.11.0",
"lint-staged": "^7.0.4",
"minimist": "^1.2.0",
"yorkie": "^1.0.3",
"inquirer": "^6.2.0",
"@vue/conventional-changelog": "^0.1.1"
}
}
3 changes: 3 additions & 0 deletions vuepress/packages/@vuepress/cli/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
__tests__
__mocks__
.temp
18 changes: 18 additions & 0 deletions vuepress/packages/@vuepress/cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# @vuepress/cli

> cli for vuepress
## APIs

### program

Current instance of [commander.js](https://github.com/tj/commander.js)

### bootstrap(options)

Launch the cli.

#### options.plugins

#### options.theme
Loading

0 comments on commit 3b56a5a

Please sign in to comment.