Docs

.github/workflows/vuepress-deploy.yml

@@ -0,0 +1,20 @@
+name: Build and Deploy Docs
+on:
+  push:
+    branches:
+      - "master"
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: vuepress-deploy
+      uses: jenkey2011/vuepress-deploy@master
+      env:
+        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+        TARGET_REPO: sebastienheyd/boilerplate
+        TARGET_BRANCH: gh-pages
+        BUILD_SCRIPT: yarn && yarn docs:build
+        BUILD_DIR: docs/.vuepress/dist

docs/.gitignore

@@ -0,0 +1,4 @@
+node_modules
+.DS_Store
+.idea
+yarn.lock

docs/.vuepress/config.js

@@ -0,0 +1,39 @@
+const {
+  getDocsNavBar,
+  getVersionsLinks,
+  getActiveVersion,
+} = require("./utils");
+
+module.exports = {
+  base: '/boilerplate/',
+  title: 'Laravel / AdminLTE 3 Boilerplate',
+  description: 'Laravel Boilerplate based on AdminLTE 3 with blade components, user management, roles, permissions, logs viewer, ...',
+  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: {
+    current: '7.x',
+    repo: '',
+    editLinks: false,
+    docsRepo: "sebastienheyd/boilerplate",
+    docsDir: '',
+    docsBranch: "docs",
+    editLinkText: '',
+    lastUpdated: false,
+    nav: [
+      { text: "Guide", link: getActiveVersion().link },
+      { text: "Version", items: getVersionsLinks() },
+      { text: 'Github', link: 'https://github.com/sebastienheyd/boilerplate' }
+    ],
+    sidebarDepth: 0,
+    sidebar: {
+      '/docs/7.x/': getDocsNavBar("7.x"),
+    }
+  },
+  plugins: [
+    '@vuepress/plugin-back-to-top',
+    '@vuepress/plugin-medium-zoom',
+  ]
+}

docs/.vuepress/enhanceApp.js

@@ -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.
+}

docs/.vuepress/styles/index.styl

@@ -0,0 +1,105 @@
+/**
+ * Custom Styles here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/config/#index-styl
+ */
+
+@import url('https://fonts.googleapis.com/css2?family=Raleway:ital,wght@0,400;0,500;0,600;0,700;1,400;1,500;1,600;1,700&display=swap');
+
+.sidebar,
+.navbar,
+.navbar .links
+  background: $bgColor !important;
+  background-color: $bgColor !important;
+
+body, html
+  font-family 'Raleway', -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif
+  background: #101212;
+
+.home .hero .action-button
+  background: #4493f8 !important
+  border: 0 !important
+  outline: 0 !important
+
+.home .hero .action-button:hover
+  background: #3489ff !important
+
+.dropdown-wrapper .nav-dropdown
+  background: $bgColor !important;
+
+.search-box input
+  background-color: transparent !important;
+
+.home .hero img
+  max-width 450px!important
+
+a[rel="noopener noreferrer"] span:has(svg.icon.outbound)
+    display: none
+
+.sidebar > .sidebar-links > li > a.sidebar-link,
+.sidebar-heading,
+a.sidebar-link
+  font-size: .95rem !important;
+  font-weight: normal !important;
+  line-height: 1.5 !important;
+  font-weight: 600 !important
+
+a.sidebar-link.active
+  border-color: #4493f8 !important
+  background: #222525 !important
+  color: rgb(96, 179, 230) !important
+
+.sidebar > .sidebar-links > li:not(:first-child)
+  margin-top: .25rem !important;
+
+blockquote
+  border-left: 8px solid #287dae;
+  background: #202222
+  color: #b2c4d2
+  padding: 1rem;
+
+h1, h2, h3, h4, h5, h6
+  color: $titleColor;
+  border-bottom: 0;
+
+.navbar .site-name
+  color: rgb(141, 201, 247) !important;
+
+hr
+  margin: 2rem 0;
+
+.theme-default-content :not(pre, figure) > code
+  background: rgb(30, 32, 33);
+  color: $accentColor;
+  border: 1px solid rgb(56, 61, 63);
+  border-radius: 3px;
+
+.page-edit
+  display: none;
+
+table
+  border-collapse: initial
+
+tr
+  border: 0 !important
+
+th, td
+  border: 0 !important
+  background: transparent
+
+th
+  background: #252829
+
+table tbody tr
+  background: #18191a !important
+
+table tbody tr:nth-child(2n+1)
+  background: #1c1f20 !important
+
+.custom-block.warning
+  background: #322f18
+  color: #f9e666
+
+.custom-block.tip
+  background: #202222
+  color: #b2c4d2

docs/.vuepress/styles/palette.styl

@@ -0,0 +1,15 @@
+/**
+ * Custom palette here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
+ */
+
+$accentColor = rgb(176, 198, 213)
+$textColor = rgb(184, 178, 169)
+$altTextColor = rgb(96, 179, 230)
+$titleColor = rgb(176, 198, 213)
+$borderColor = #383d3f
+$codeBgColor = #18191a
+$bgColor = #191b1c
+
+$contentWidth = 1200px

docs/.vuepress/utils.js

@@ -0,0 +1,123 @@
+const ACTIVE_VERSION = "7.x";
+
+function getDocsNavBar(version) {
+    switch (version) {
+        case "7.x":
+            return [
+                ["", 'Introduction'],
+                "installation",
+                {
+                    title: 'Configuration',
+                    children: [
+                        'configuration/app',
+                        'configuration/auth',
+                        'configuration/dashboard',
+                        'configuration/laratrust',
+                        'configuration/locale',
+                        'configuration/menu',
+                        'configuration/theme',
+                    ]
+                },
+                {
+                    title: 'Blade components',
+                    children: [
+                        'components/card',
+                        'components/codemirror',
+                        'components/colorpicker',
+                        'components/datatable',
+                        'components/daterangepicker',
+                        'components/datetimepicker',
+                        'components/form',
+                        'components/icheck',
+                        'components/infobox',
+                        'components/input',
+                        'components/minify',
+                        'components/password',
+                        'components/select2',
+                        'components/smallbox',
+                        'components/tinymce',
+                        'components/toggle',
+                    ]
+                },
+                {
+                    title: 'Dashboard',
+                    children: [
+                        'dashboard/generate_widget',
+                        'dashboard/widget_usage',
+                    ]
+                },
+                {
+                    title: 'Datatables',
+                    children: [
+                        'datatables/create',
+                        'datatables/datasource',
+                        'datatables/options',
+                        'datatables/column',
+                        'datatables/button',
+                    ]
+                },
+                {
+                    title: 'How-to',
+                    children: [
+                        'howto/add_menu_items',
+                        'howto/add_navbar_items',
+                        'howto/add_permissions',
+                        'howto/call_css_js',
+                        'howto/change_dashboard',
+                        'howto/change_theme',
+                        'howto/generate_text_gpt',
+                        'howto/scaffold',
+                        'howto/user_settings',
+                    ]
+                },
+                {
+                    title: 'Javascript plugins',
+                    children: [
+                        'plugins/bootbox',
+                        'plugins/codemirror',
+                        'plugins/datatables',
+                        'plugins/daterangepicker',
+                        'plugins/datetimepicker',
+                        'plugins/fileinput',
+                        'plugins/fullcalendar',
+                        'plugins/icheck',
+                        'plugins/moment',
+                        'plugins/select2',
+                        'plugins/tinymce',
+                        'plugins/toastr',
+                    ]
+                },
+                {
+                    title: 'Broadcasting',
+                    children: [
+                        ['broadcasting/configuration', 'Configuration'],
+                        'broadcasting/usage',
+                        'broadcasting/example',
+                    ]
+                },
+                'language',
+                'update',
+                'troubleshooting',
+                'tests',
+                'about',
+            ];
+    }
+}
+
+function getVersionsLinks(preLink = "docs") {
+    let links = [
+        { text: "7.x", link: `/${preLink}/7.x/` },
+    ].sort((a, b) => a.text < b.text);
+
+    return links;
+}
+
+function getActiveVersion() {
+    return getVersionsLinks().find((item) => item.text == ACTIVE_VERSION);
+}
+
+module.exports = {
+    getDocsNavBar,
+    getVersionsLinks,
+    getActiveVersion,
+};

docs/Dockerfile

@@ -0,0 +1,9 @@
+FROM node:16
+
+RUN mkdir /local
+RUN npm install -g @vue/cli
+
+WORKDIR /local
+EXPOSE 8080
+
+CMD ["/bin/bash", "-c", "yarn install && yarn docs:dev --host 0.0.0.0"]

docs/Makefile

@@ -0,0 +1,35 @@
+.PHONY:help start stop restart status logs rebuild pull remove
+.DEFAULT_GOAL=help
+
+CYAN   = \033[0;36m
+NC     = \033[m
+
+help:
+	@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+start: ## Start container port 8080
+	@docker-compose up -d --remove-orphans
+
+stop: ## Stop container
+	@docker-compose down --remove-orphans
+
+restart: stop start ## Restart container
+
+pull: ## Pull latest version of Vuepress
+	@docker-compose pull vuepress
+
+remove: ## Remove container
+	@docker-compose down --rmi all -v --remove-orphans
+
+rebuild: stop ## Rebuild container
+	@docker-compose build --no-cache --compress vuepress
+	@docker-compose up -d --remove-orphans
+
+status: ## Container status
+	@docker-compose ps
+
+logs: ## Container logs
+	@docker-compose logs --follow vuepress
+
+clean: ## Clean container volume content
+	@sudo rm -rf node_modules yarn.lock

docs/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '3'
+services:
+  vuepress:
+    build: .
+    container_name: boilerplate-docs
+    ports:
+      - "8080:8080"
+    volumes:
+      - .:/local
+    tty: true