From dc102d24f0fcb6247388880abc7f3208d0b7a9eb Mon Sep 17 00:00:00 2001 From: Jannik Schönartz Date: Sun, 10 Mar 2019 03:50:32 +0000 Subject: [documentation] Add documentation site Override css (Design the topbar & site) <-- A lot of Udo's help Create structure for the differen pages Start writing the installation Write the getting started API site Write documentation of the authentication api Write documentation of the setup api --- documentation/.vuepress/config.js | 27 ++++++ documentation/.vuepress/override.styl | 94 +++++++++++++++++++++ documentation/.vuepress/public/favicon.ico | Bin 0 -> 15086 bytes .../.vuepress/public/img/bss_screenshot.PNG | Bin 0 -> 85869 bytes documentation/.vuepress/public/img/logo-light.svg | 18 ++++ documentation/.vuepress/public/img/logo.svg | 18 ++++ 6 files changed, 157 insertions(+) create mode 100644 documentation/.vuepress/config.js create mode 100644 documentation/.vuepress/override.styl create mode 100644 documentation/.vuepress/public/favicon.ico create mode 100644 documentation/.vuepress/public/img/bss_screenshot.PNG create mode 100644 documentation/.vuepress/public/img/logo-light.svg create mode 100644 documentation/.vuepress/public/img/logo.svg (limited to 'documentation/.vuepress') diff --git a/documentation/.vuepress/config.js b/documentation/.vuepress/config.js new file mode 100644 index 0000000..0a8f1b3 --- /dev/null +++ b/documentation/.vuepress/config.js @@ -0,0 +1,27 @@ +module.exports = { + title: 'BAS Documentation', + description: 'Boot Auswahl Server', + themeConfig: { + logo: '/img/logo-light.svg', + nav: [ + { text: 'Home', link: '/' }, + { text: 'Installation', link: '/installation/' }, + { text: 'API', link: '/api/' }, + { text: 'Webapp', link: '/webapp/' } + ], + sidebar: { + '/installation/': [ + '' + ], + '/api/': [ + '', + 'collections' + ], + '/webapp/': [ + '', + 'modules' + ] + }, + sidebarDepth: 1 + }, +} \ No newline at end of file diff --git a/documentation/.vuepress/override.styl b/documentation/.vuepress/override.styl new file mode 100644 index 0000000..8090c85 --- /dev/null +++ b/documentation/.vuepress/override.styl @@ -0,0 +1,94 @@ +// showing default values +$accentColor = #0095ff +$textColor = #2c3e50 +$borderColor = #eaecef +$codeBgColor = #282c34 +//$codeBgColor = #4f5665 + +// Custom variables +$bgColorNav = #fff +$textColorNav = #000 + +$bgColor = #fafafa +$fgColor = #fff +$color = #000 +$border = #0000001f + +darknav = false +if darknav + $bgColorNav = #212121 + $textColorNav = #fff + $bgSearch = #424242 + $borderSearch = #303030 + $bordersizeSearch = 2px + $borderNav = none + +darktheme = false +if darktheme + $bgColorNav = #212121 + $textColorNav = #fff + $bgColor = #303030 + $fgColor = #424242 + $color = #fff + $border = #ffffff1f + $bgSearch = #424242 + $borderSearch = #303030 + $bordersizeSearch = 2px + $borderNav = none + +body + background-color $bgColor +blockquote + font-size 1rem !important + color dimgrey !important + +.theme-container + .navbar + background-color $bgColorNav + border-bottom $borderNav + padding-top 0 + + .home-link + overflow hidden + height: 57px + + .logo + width 341.141px + max-width calc(100% - 30px) + height auto + transform translateY(-40%) + z-index 2 + + .site-name + margin-top 11.2px + color $textColorNav + @media (max-width: 1140px) + .site-name + display none + + .links + background-color transparent + color $textColorNav + + :hover + color $textColorNav + + .router-link-active + color $textColorNav + + .search-box input + background-color $bgSearch + border $bordersizeSearch solid $borderSearch + z-index 1 + + .search-box .focused + z-index 3 + + .page + background-color $bgColor + color $color + + .sidebar + background-color $fgColor + color $color + border-right $border solid 1px diff --git a/documentation/.vuepress/public/favicon.ico b/documentation/.vuepress/public/favicon.ico new file mode 100644 index 0000000..1bef76b Binary files /dev/null and b/documentation/.vuepress/public/favicon.ico differ diff --git a/documentation/.vuepress/public/img/bss_screenshot.PNG b/documentation/.vuepress/public/img/bss_screenshot.PNG new file mode 100644 index 0000000..2fb8504 Binary files /dev/null and b/documentation/.vuepress/public/img/bss_screenshot.PNG differ diff --git a/documentation/.vuepress/public/img/logo-light.svg b/documentation/.vuepress/public/img/logo-light.svg new file mode 100644 index 0000000..0647108 --- /dev/null +++ b/documentation/.vuepress/public/img/logo-light.svg @@ -0,0 +1,18 @@ + + + + + + + + + + diff --git a/documentation/.vuepress/public/img/logo.svg b/documentation/.vuepress/public/img/logo.svg new file mode 100644 index 0000000..cadb999 --- /dev/null +++ b/documentation/.vuepress/public/img/logo.svg @@ -0,0 +1,18 @@ + + + + + + + + + + -- cgit v1.2.3-55-g7522