diff --git a/.gitignore b/.gitignore index fd44203b3..cac042cb5 100644 --- a/.gitignore +++ b/.gitignore @@ -26,7 +26,6 @@ bower_components/ // Docs -Gemfile.lock docs/_site docs_html/ .jekyll-cache/ diff --git a/docs/Gemfile b/docs/Gemfile index 31aaee9b9..918ca2b5d 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,4 +1,9 @@ source 'https://rubygems.org' -gem 'github-pages' -gem 'wdm', '~> 0.1.1', :install_if => Gem.win_platform? +group :development, :test do + gem 'jekyll', '~> 4.1.0' + gem 'jekyll-seo-tag', '~> 2.6.1' + gem 'jekyll-sitemap', '~> 1.4.0' + gem 'wdm', '~> 0.1.1', :install_if => Gem.win_platform? +end + diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 000000000..c4510e101 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,80 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) + colorator (1.1.0) + concurrent-ruby (1.1.6) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + eventmachine (1.2.7) + eventmachine (1.2.7-x64-mingw32) + ffi (1.13.0) + ffi (1.13.0-x64-mingw32) + forwardable-extended (2.6.0) + http_parser.rb (0.6.0) + i18n (1.8.2) + concurrent-ruby (~> 1.0) + jekyll (4.1.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 1.0) + jekyll-sass-converter (~> 2.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (~> 0.4.0) + pathutil (~> 0.9) + rouge (~> 3.0) + safe_yaml (~> 1.0) + terminal-table (~> 1.8) + jekyll-sass-converter (2.1.0) + sassc (> 2.0.1, < 3.0) + jekyll-seo-tag (2.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + kramdown (2.2.1) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.2.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.4.0) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.5) + rb-fsevent (0.10.4) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.4) + rouge (3.19.0) + safe_yaml (1.0.5) + sassc (2.3.0) + ffi (~> 1.9) + sassc (2.3.0-x64-mingw32) + ffi (~> 1.9) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + unicode-display_width (1.7.0) + wdm (0.1.1) + +PLATFORMS + ruby + x64-mingw32 + +DEPENDENCIES + jekyll (~> 4.1.0) + jekyll-seo-tag (~> 2.6.1) + jekyll-sitemap (~> 1.4.0) + wdm (~> 0.1.1) + +BUNDLED WITH + 1.17.3 diff --git a/docs/_config.yml b/docs/_config.yml index d145f65d5..306240cb3 100755 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,106 +1,84 @@ -# Welcome to Jekyll! -# -# This config file is meant for settings that affect your whole blog, values -# which you are expected to set up once and rarely edit after that. If you find -# yourself editing this file very often, consider using Jekyll's data files -# feature for the data you need to update frequently. -# -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'bundle exec jekyll serve'. If you change this file, please restart the server process. +title: AdminLTE v3 Documentation +version: v3.0.5 +description: AdminLTE v3 Documentation -# Site settings -# These are used to personalize your new site. If you look in the HTML files, -# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. -# You can create any custom variable you would like, and they will be accessible -# in the templates via {{ site.myvariable }}. -markdown: kramdown +markdown: kramdown kramdown: auto_ids: false highlighter: rouge plugins: - jekyll-seo-tag - -title: AdminLTE v3 Documentation -version: v3.0.5 -description: >- # this means to ignore newlines until "baseurl:" - AdminLTE v3 Documentation + - jekyll-sitemap navigation: -- title: Installation - url: index.html - icon: fas fa-microchip -- title: Dependencies & Plugins - url: dependencies.html - icon: fas fa-handshake -- title: Layout - url: layout.html - icon: fas fa-copy -- title: Components - icon: fas fa-th - url: components - subitems: - - title: Main Header - url: components/main-header.html - - title: Main Sidebar - url: components/main-sidebar.html - - title: Control Sidebar - url: components/control-sidebar.html - - title: Card - url: components/cards.html - - title: Small-/ Info-Box - url: components/boxes.html - - title: Direct Chat - url: components/direct-chat.html - - title: Timeline - url: components/timeline.html - - title: Ribbons - url: components/ribbons.html - - title: Miscellaneous - url: components/miscellaneous.html - - title: Plugins - url: components/plugins.html -- title: JavaScript - icon: fas fa-code - url: javascript - subitems: - - title: Layout - url: javascript/layout.html - - title: Push Menu - url: javascript/push-menu.html - - title: Treeview - url: javascript/treeview.html - - title: Card Widget - url: javascript/card-widget.html - - title: CardRefresh - url: javascript/card-refresh.html - - title: Control Sidebar - url: javascript/control-sidebar.html - - title: Direct Chat - url: javascript/direct-chat.html - - title: Todo List - url: javascript/todo-list.html - - title: Toasts - url: javascript/toasts.html -- title: Browser Support - url: browser-support.html - icon: fab fa-chrome -- title: Upgrade Guide - url: upgrade-guide.html - icon: fas fa-hand-point-up -- title: Implementations - url: implementations.html - icon: fas fa-bookmark -- title: FAQ - url: faq.html - icon: fas fa-question-circle -- title: License - url: license.html - icon: fas fa-file-alt - -# Exclude from processing. -# The following items will not be processed, by default. Create a custom list -# to override the default setting. -exclude: - - Gemfile - - Gemfile.lock + - title: Installation + url: index.html + icon: fas fa-microchip + - title: Dependencies & Plugins + url: dependencies.html + icon: fas fa-handshake + - title: Layout + url: layout.html + icon: fas fa-copy + - title: Components + icon: fas fa-th + url: components + subitems: + - title: Main Header + url: components/main-header.html + - title: Main Sidebar + url: components/main-sidebar.html + - title: Control Sidebar + url: components/control-sidebar.html + - title: Card + url: components/cards.html + - title: Small-/ Info-Box + url: components/boxes.html + - title: Direct Chat + url: components/direct-chat.html + - title: Timeline + url: components/timeline.html + - title: Ribbons + url: components/ribbons.html + - title: Miscellaneous + url: components/miscellaneous.html + - title: Plugins + url: components/plugins.html + - title: JavaScript + icon: fas fa-code + url: javascript + subitems: + - title: Layout + url: javascript/layout.html + - title: Push Menu + url: javascript/push-menu.html + - title: Treeview + url: javascript/treeview.html + - title: Card Widget + url: javascript/card-widget.html + - title: CardRefresh + url: javascript/card-refresh.html + - title: Control Sidebar + url: javascript/control-sidebar.html + - title: Direct Chat + url: javascript/direct-chat.html + - title: Todo List + url: javascript/todo-list.html + - title: Toasts + url: javascript/toasts.html + - title: Browser Support + url: browser-support.html + icon: fab fa-chrome + - title: Upgrade Guide + url: upgrade-guide.html + icon: fas fa-hand-point-up + - title: Implementations + url: implementations.html + icon: fas fa-bookmark + - title: FAQ + url: faq.html + icon: fas fa-question-circle + - title: License + url: license.html + icon: fas fa-file-alt