Skip to content

Commit 370fb79

Browse files
author
Farrin Reid
committed
[docs] commiting docs
1 parent 7e5b87b commit 370fb79

File tree

13 files changed

+12377
-1137
lines changed

13 files changed

+12377
-1137
lines changed

‎ReadMe.md

Lines changed: 13 additions & 804 deletions
Large diffs are not rendered by default.

‎deploy.docs.sh

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
#!/usr/bin/env sh
2+
3+
# abort on errors
4+
set -e
5+
6+
# build
7+
npm run docs:build
8+
9+
# navigate into the build output directory
10+
cd docs/.vuepress/dist
11+
12+
# if you are deploying to a custom domain
13+
# echo 'www.example.com' > CNAME
14+
15+
git init
16+
git add -A
17+
git commit -m '[docs] deploy'
18+
19+
git push -f [email protected]:blakmatrix/node-zendesk.git master:gh-pages
20+
21+
cd -

‎docs/.npmignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
pids
2+
logs
3+
node_modules
4+
npm-debug.log
5+
coverage/
6+
run
7+
dist
8+
.DS_Store
9+
.nyc_output
10+
.basement
11+
config.local.js
12+
basement_dist

‎docs/.vuepress/config.js

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
const { description } = require('../../package')
2+
3+
module.exports = {
4+
/**
5+
* Ref：https://v1.vuepress.vuejs.org/config/#title
6+
*/
7+
title: 'node-zendesk',
8+
/**
9+
* Ref：https://v1.vuepress.vuejs.org/config/#description
10+
*/
11+
description: description,
12+
13+
base: '/node-zendesk/',
14+
15+
/**
16+
* Extra tags to be injected to the page HTML `<head>`
17+
*
18+
* ref：https://v1.vuepress.vuejs.org/config/#head
19+
*/
20+
head: [
21+
['meta', { name: 'theme-color', content: '#3eaf7c' }],
22+
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
23+
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }]
24+
],
25+
26+
/**
27+
* Theme configuration, here is the default theme configuration for VuePress.
28+
*
29+
* ref：https://v1.vuepress.vuejs.org/theme/default-theme-config.html
30+
*/
31+
themeConfig: {
32+
logo: '/Node_Zendesk_logo.svg',
33+
repo: 'blakmatrix/node-zendesk',
34+
editLinks: true,
35+
docsDir: 'docs',
36+
editLinks: true,
37+
editLinkText: 'Edit this page on GitHub',
38+
lastUpdated: 'Last Updated',
39+
smoothScroll: true,
40+
nav: [
41+
{
42+
text: 'Guide',
43+
link: '/guide/',
44+
},
45+
{
46+
text: 'API',
47+
link: '/api/'
48+
}
49+
],
50+
sidebar: 'auto'
51+
},
52+
53+
/**
54+
* Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/
55+
*/
56+
plugins: [
57+
'@vuepress/plugin-back-to-top',
58+
'@vuepress/plugin-medium-zoom',
59+
]
60+
}

‎docs/.vuepress/enhanceApp.js

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/**
2+
* Client app enhancement file.
3+
*
4+
* https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
5+
*/
6+
7+
export default ({
8+
Vue, // the version of Vue being used in the VuePress app
9+
options, // the options for the root Vue instance
10+
router, // the router instance for the app
11+
siteData // site metadata
12+
}) => {
13+
// ...apply enhancements for the site.
14+
}

‎docs/.vuepress/public/Node_Zendesk_logo.svg

Lines changed: 132 additions & 0 deletions
Loading

‎docs/.vuepress/styles/index.styl

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* Custom Styles here.
3+
*
4+
* ref：https://v1.vuepress.vuejs.org/config/#index-styl
5+
*/
6+
7+
.home .hero img
8+
max-width 450px!important

‎docs/.vuepress/styles/palette.styl

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
/**
2+
* Custom palette here.
3+
*
4+
* ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
5+
*/
6+
7+
$accentColor = #3eaf7c
8+
$textColor = #2c3e50
9+
$borderColor = #eaecef
10+
$codeBgColor = #282c34

0 commit comments

Comments
 (0)