start docs

This commit is contained in:
wh1te909 2020-11-14 07:51:22 +00:00
parent a8d9fa75d4
commit 8b351edf9c
11 changed files with 10905 additions and 0 deletions

1
.gitignore vendored
View File

@ -42,3 +42,4 @@ api/tacticalrmm/accounts/management/commands/random_data.py
versioninfo.go
resource.syso
htmlcov/
docs/.vuepress/dist

12
docs/.npmignore Executable file
View File

@ -0,0 +1,12 @@
pids
logs
node_modules
npm-debug.log
coverage/
run
dist
.DS_Store
.nyc_output
.basement
config.local.js
basement_dist

41
docs/.vuepress/config.js Executable file
View File

@ -0,0 +1,41 @@
const { description } = require('../package')
module.exports = {
base: '/tacticalrmm/',
title: 'Tactical RMM',
description: description,
head: [
['meta', { name: 'theme-color', content: '#3eaf7c' }],
['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }]
],
themeConfig: {
repo: '',
editLinks: false,
docsDir: '',
editLinkText: '',
lastUpdated: false,
nav: [
{
text: 'Guide',
link: '/guide/',
}
],
sidebar: {
'/guide/': [
{
title: 'Guide',
collapsable: false,
children: [
'',
]
}
],
}
},
plugins: [
//'@vuepress/plugin-back-to-top',
//'@vuepress/plugin-medium-zoom',
]
}

14
docs/.vuepress/enhanceApp.js Executable file
View File

@ -0,0 +1,14 @@
/**
* Client app enhancement file.
*
* https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
*/
export default ({
Vue, // the version of Vue being used in the VuePress app
options, // the options for the root Vue instance
router, // the router instance for the app
siteData // site metadata
}) => {
// ...apply enhancements for the site.
}

View File

@ -0,0 +1,8 @@
/**
* Custom Styles here.
*
* refhttps://v1.vuepress.vuejs.org/config/#index-styl
*/
.home .hero img
max-width 450px!important

View File

@ -0,0 +1,10 @@
/**
* Custom palette here.
*
* refhttps://v1.vuepress.vuejs.org/zh/config/#palette-styl
*/
$accentColor = #3eaf7c
$textColor = #2c3e50
$borderColor = #eaecef
$codeBgColor = #282c34

14
docs/deploy.sh Executable file
View File

@ -0,0 +1,14 @@
#!/usr/bin/env sh
set -e
npm run build
cd .vuepress/dist
git init
git add -A
git commit -m 'deploy'
git push -f git@github.com:wh1te909/tacticalrmm.git develop:gh-pages
cd -

2
docs/guide/README.md Executable file
View File

@ -0,0 +1,2 @@
# Installation

6
docs/index.md Executable file
View File

@ -0,0 +1,6 @@
---
home: true
heroImage: https://v1.vuepress.vuejs.org/hero.png
actionText: Documentation →
actionLink: /guide/
---

10783
docs/package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

14
docs/package.json Executable file
View File

@ -0,0 +1,14 @@
{
"name": "tacticalrmm",
"description": "A remote monitoring and management tool",
"private": true,
"version": "0.0.1",
"scripts": {
"dev": "vuepress dev",
"build": "vuepress build"
},
"license": "MIT",
"devDependencies": {
"vuepress": "^1.5.3"
}
}