Skip to content

Commit 35435b1

Browse files
ArmourArmour
committed
Docs(vuepress): vuepress basic setup
0 parents  commit 35435b1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+9959
-0
lines changed

‎.circleci/config.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Javascript Node CircleCI 2.0 configuration file
2+
#
3+
# Check https://circleci.com/docs/2.0/language-javascript/ for more details
4+
#
5+
version: 2
6+
7+
jobs:
8+
build:
9+
docker:
10+
- image: circleci/node:11
11+
12+
working_directory: ~/vue-typescript-admin-docs
13+
14+
steps:
15+
- checkout
16+
17+
# Download and cache dependencies
18+
- restore_cache:
19+
keys:
20+
- v1-dependencies-{{ checksum "package.json" }}
21+
# fallback to using the latest cache if no exact match is found
22+
- v1-dependencies-
23+
24+
- run: yarn install
25+
26+
- save_cache:
27+
paths:
28+
- node_modules
29+
key: v1-dependencies-{{ checksum "package.json" }}
30+
31+
- run: yarn lint && yarn docs:build

‎.editorconfig

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# http://editorconfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Unix-style newlines with a newline ending every file
7+
[*]
8+
charset = utf-8
9+
end_of_line = lf
10+
insert_final_newline = true
11+
trim_trailing_whitespace = true
12+
13+
# Indentation override for js(x), ts(x) and vue files
14+
[*.{js,jsx,ts,tsx,vue}]
15+
indent_size = 2
16+
indent_style = space
17+
18+
# Indentation override for css related files
19+
[*.{css,styl,scss,less,sass}]
20+
indent_size = 2
21+
indent_style = space
22+
23+
# Indentation override for html files
24+
[*.html]
25+
indent_size = 2
26+
indent_style = space
27+
28+
# Trailing space override for markdown file
29+
[*.md]
30+
trim_trailing_whitespace = false
31+
32+
# Indentation override for config files
33+
[*.{json,yml}]
34+
indent_size = 2
35+
indent_style = space

‎.gitattributes

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Details per file setting:
2+
# text These files should be normalized (i.e. convert CRLF to LF).
3+
# binary These files are binary and should be left untouched.
4+
5+
# Auto detect text files and perform LF normalization
6+
* text=auto
7+
# The above will handle all files NOT found below
8+
9+
# SOURCE CODE
10+
*.bat text eol=crlf
11+
*.sh text eol=lf
12+
13+
# COMPILED FILES
14+
*.dll binary
15+
*.dylib binary
16+
*.exe binary
17+
*.so binary
18+
19+
# DOCUMENTATION
20+
*.md text
21+
*.txt text
22+
LICENSE text
23+
24+
# CONFIGS
25+
.editorconfig text
26+
.gitattributes text
27+
.gitignore text
28+
*.conf text
29+
*.config text
30+
*.json text
31+
*.lock text
32+
*.toml text
33+
*.yaml text
34+
*.yml text
35+
36+
# GRAPHICS
37+
*.ai binary
38+
*.bmp binary
39+
*.eps binary
40+
*.gif binary
41+
*.heic binary
42+
*.ico binary
43+
*.jpeg binary
44+
*.jpg binary
45+
*.pdf binary
46+
*.png binary
47+
*.psb binary
48+
*.psd binary
49+
*.svg text
50+
*.tif binary
51+
*.tiff binary
52+
*.wbmp binary
53+
*.webp binary
54+
55+
# AUDIO
56+
*.aac binary
57+
*.flac binary
58+
*.m4a binary
59+
*.mid binary
60+
*.midi binary
61+
*.mp3 binary
62+
*.mp4a binary
63+
*.mpga binary
64+
*.oga binary
65+
*.ogg binary
66+
*.wav binary
67+
*.weba binary
68+
69+
# VIDEO
70+
*.3g2 binary
71+
*.3gp binary
72+
*.asf binary
73+
*.avi binary
74+
*.f4v binary
75+
*.fla binary
76+
*.flv binary
77+
*.m4v binary
78+
*.mov binary
79+
*.mp4 binary
80+
*.mpeg binary
81+
*.mpg binary
82+
*.ogv binary
83+
*.qt binary
84+
*.swf binary
85+
*.webm binary
86+
87+
# ARCHIVES
88+
*.7z binary
89+
*.gz binary
90+
*.jar binary
91+
*.rar binary
92+
*.tar binary
93+
*.zip binary
94+
95+
# FONTS
96+
*.eot binary
97+
*.otf binary
98+
*.ttf binary
99+
*.woff binary
100+
*.woff2 binary

‎.github/CODE_OF_CONDUCT.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
education, socio-economic status, nationality, personal appearance, race,
10+
religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html)
72+
73+
[homepage]: https://www.contributor-covenant.org

‎.github/COMMIT_CONVENTION.md

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Git Commit Message Convention
2+
3+
> This is adapted from [Angular's commit convention](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular).
4+
5+
## TL;DR
6+
7+
Messages must be matched by the following regex:
8+
9+
``` js
10+
/^(Revert: )?(Feature|Fix|Docs|Improve|Config|Example|Refactor|Style|Test|Build|CI)(\(.+\))?: .{1,80}/
11+
```
12+
13+
## Commit Message Format
14+
15+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
16+
17+
```text
18+
<type>(<scope>): <subject>
19+
<BLANK LINE>
20+
<body>
21+
<BLANK LINE>
22+
<footer>
23+
```
24+
25+
The **header** is mandatory and the **scope** of the header is optional.
26+
27+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
28+
to read on GitHub as well as in various git tools.
29+
30+
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
31+
32+
Samples: (even more [samples](https://github.com/Armour/vue-typescript-admin-docs/commits/master))
33+
34+
```text
35+
Docs(changelog): update changelog to beta.5
36+
```
37+
38+
```text
39+
Feature($browser): onUrlChange event (popstate/hashchange/polling)
40+
41+
Added new event to $browser:
42+
- forward popstate event if available
43+
- forward hashchange event if popstate not available
44+
- do polling when neither popstate nor hashchange available
45+
46+
Breaks $browser.onHashChange, which was removed (use onUrlChange instead)
47+
```
48+
49+
```text
50+
Fix(release): need to depend on latest rxjs and zone.js
51+
52+
The version in our package.json gets copied to the one we publish, and users need the latest of these.
53+
54+
Closes #123, #245, #992
55+
56+
BREAKING CHANGE: isolate scope bindings definition has changed and
57+
the inject option for the directive controller injection was removed.
58+
59+
To migrate the code follow the example below:
60+
61+
Before:
62+
63+
scope: {
64+
myAttr: 'attribute',
65+
myBind: 'bind',
66+
myExpression: 'expression',
67+
myEval: 'evaluate',
68+
myAccessor: 'accessor'
69+
}
70+
71+
After:
72+
73+
scope: {
74+
myAttr: '@',
75+
myBind: '@',
76+
myExpression: '&',
77+
// myEval - usually not useful, but in cases where the expression is assignable, you can use '='
78+
myAccessor: '=' // in directive's template change myAccessor() to myAccessor
79+
}
80+
81+
The removed `inject` wasn't generaly useful for directives so there should be no code using it.
82+
```
83+
84+
### Revert
85+
86+
If the commit reverts a previous commit, it should begin with `Revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
87+
88+
### Type
89+
90+
Must be one of the following:
91+
92+
* **Build**: Changes that affect the build system or external dependencies (example scopes: gulp, npm, yarn)
93+
* **CI**: Changes to CI related configuration files and scripts (example scopes: travis, circle, browserstack)
94+
* **Config**: Changes to other configuration files (example scopes: webpack, babel, docker)
95+
* **Docs**: Documentation only changes (example scopes: readme, changelog)
96+
* **Example**: Changes for example code
97+
* **Feature**: A new feature
98+
* **Fix**: A bug fix
99+
* **Improve**: Backwards-compatible enhancement changes
100+
* **Refactor**: A code change that neither fixes a bug nor adds a feature
101+
* **Style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
102+
* **Test**: Changes for testing code
103+
104+
If the prefix is `Feature` or `Fix`, it will appear in the changelog. However if there is any [BREAKING CHANGE](#footer), the commit will always appear in the changelog.
105+
106+
### Scope
107+
108+
The scope could be anything specifying place of the commit change. For example `core`, `compiler`, `ssr`, `v-model`, `transition` etc...
109+
110+
### Subject
111+
112+
The subject contains succinct description of the change:
113+
114+
* use the imperative, present tense: "change" not "changed" nor "changes"
115+
* don't capitalize the first letter
116+
* no dot (.) at the end
117+
118+
### Body
119+
120+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
121+
The body should include the motivation for the change and contrast this with previous behavior.
122+
123+
### Footer
124+
125+
The footer should contain any information about **Breaking Changes** and is also the place to
126+
reference GitHub issues that this commit **Closes**.
127+
128+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
129+
130+
A detailed explanation can be found in this [document](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit)

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy