summaryrefslogtreecommitdiffstats
path: root/documentation/.vuepress
diff options
context:
space:
mode:
authorJannik Schönartz2019-03-10 04:50:32 +0100
committerJannik Schönartz2019-03-10 04:50:32 +0100
commitdc102d24f0fcb6247388880abc7f3208d0b7a9eb (patch)
treef5c7af2f8cb217488052b71978f45a667d03b363 /documentation/.vuepress
parent[ipxe] Add parameter to api how many lines the response should send and adjus... (diff)
downloadbas-dc102d24f0fcb6247388880abc7f3208d0b7a9eb.tar.gz
bas-dc102d24f0fcb6247388880abc7f3208d0b7a9eb.tar.xz
bas-dc102d24f0fcb6247388880abc7f3208d0b7a9eb.zip
[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
Diffstat (limited to 'documentation/.vuepress')
-rw-r--r--documentation/.vuepress/config.js27
-rw-r--r--documentation/.vuepress/override.styl94
-rw-r--r--documentation/.vuepress/public/favicon.icobin0 -> 15086 bytes
-rw-r--r--documentation/.vuepress/public/img/bss_screenshot.PNGbin0 -> 85869 bytes
-rw-r--r--documentation/.vuepress/public/img/logo-light.svg18
-rw-r--r--documentation/.vuepress/public/img/logo.svg18
6 files changed, 157 insertions, 0 deletions
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
--- /dev/null
+++ b/documentation/.vuepress/public/favicon.ico
Binary files 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
--- /dev/null
+++ b/documentation/.vuepress/public/img/bss_screenshot.PNG
Binary files 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 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
+<svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+ viewBox="0 0 655 768" style="enable-background:new 0 0 655 768;" xml:space="preserve">
+<style type="text/css">
+ .st0{fill:#424242;}
+ .st1{fill:#0095FF;}
+ .st2{fill:#004373;}
+ .st3{fill:#0076CA;}
+ .st4{fill:#005998;}
+</style>
+<polygon id="XMLID_5_" class="st0" points="618.8,360.3 3.5,715.5 3.5,753.6 651.8,379.4 "/>
+<polygon id="XMLID_13_" class="st1" points="586,342.5 585.4,342.9 171.5,582.7 171.5,491.3 428.4,343 428.5,342.9 427.8,342.5
+ 333.5,288.1 333.5,196.3 "/>
+<polygon id="XMLID_14_" class="st2" points="249.5,147.6 249.5,239.6 87.5,146.1 87.5,631.3 3.5,680 3.5,5.1 5.5,6.2 "/>
+<polygon id="XMLID_8_" class="st3" points="586,342.5 585.4,342.9 428.4,343 428.5,342.9 427.8,342.5 333.5,288.1 333.5,196.3 "/>
+<polygon id="XMLID_11_" class="st4" points="249.5,147.6 249.5,239.6 87.5,146.1 5.5,6.2 "/>
+</svg>
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 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
+<svg version="1.1" id="Ebene_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+ viewBox="0 0 655 768" style="enable-background:new 0 0 655 768;" xml:space="preserve">
+<style type="text/css">
+ .st0{fill:#FFFFFF;}
+ .st1{fill:#0095FF;}
+ .st2{fill:#004373;}
+ .st3{fill:#0076CA;}
+ .st4{fill:#005998;}
+</style>
+<polygon id="XMLID_5_" class="st0" points="618.8,360.3 3.5,715.5 3.5,753.6 651.8,379.4 "/>
+<polygon id="XMLID_13_" class="st1" points="586,342.5 585.4,342.9 171.5,582.7 171.5,491.3 428.4,343 428.5,342.9 427.8,342.5
+ 333.5,288.1 333.5,196.3 "/>
+<polygon id="XMLID_14_" class="st2" points="249.5,147.6 249.5,239.6 87.5,146.1 87.5,631.3 3.5,680 3.5,5.1 5.5,6.2 "/>
+<polygon id="XMLID_8_" class="st3" points="586,342.5 585.4,342.9 428.4,343 428.5,342.9 427.8,342.5 333.5,288.1 333.5,196.3 "/>
+<polygon id="XMLID_11_" class="st4" points="249.5,147.6 249.5,239.6 87.5,146.1 5.5,6.2 "/>
+</svg>