Implement GitHub page for docs (#1312)

* install vite press and migrate wiki

* github actions

* Rename deploy.yml to deploy-docs.yml

* Improve deploy docs action

* Do not export docs when installing with composer or other tool

* Add some updates from the Wiki pages

* Remove unused images

* Improve img layout for authentication view classes of layout and styling

* Setup favicon

* Use Badge on versions sidenotes

* Setup logo

* Fix some links

* Remove WIKI references from contribution guides

---------

Co-authored-by: Diego Smania <[email protected]>

.gitattributes

@@ -3,5 +3,8 @@
 /.github            export-ignore
 /.scrutinizer.yml   export-ignore
 /.styleci.yml       export-ignore
+/docs               export-ignore
+/package.json       export-ignore
+/package-lock.json  export-ignore
 /phpunit.xml.dist   export-ignore
 /tests              export-ignore

.github/workflows/deploy-docs.yml

@@ -0,0 +1,82 @@
+# A workflow for building the documentation with VitePress and deploying it on
+# GitHub Pages.
+#
+name: Build and Deploy Documentation
+
+on:
+  # Triggers the workflow on push events for the "master" branch.
+  push:
+    branches: [master]
+
+  # Allows you to run this workflow manually from the Actions tab.
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages.
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allows only one concurrent deployment, skipping runs queued between the run
+# in-progress and latest queued. However, do NOT cancel in-progress runs as we
+# want to allow these production deployments to complete.
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  # Job for build the documentation with VitePress.
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checks-out the source code.
+      - name: Checkout Source Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+
+      # Setup Node.js JavaScript runtime.
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      # Setup Github Pages.
+      - name: Setup Github Pages
+        uses: actions/configure-pages@v4
+
+      # Install Node.js dependencies.
+      - name: Install Node.js Dependencies
+        run: npm ci
+
+      # Build documentation with VitePress
+      - name: Build Docs
+        run: npm run docs:build
+
+      # Package and upload the website documentation as an artifact (named
+      # github-pages by default) to be used on the deployment job. An artifact
+      # allows you to persist data after a job has completed, and share that
+      # data with another job in the same workflow.
+      - name: Upload Docs Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/.vitepress/dist
+
+  # Job for deploy the documentation to Github Pages.
+  deploy:
+    runs-on: ubuntu-latest
+
+    # This job requires the build job to be executed first.
+    needs: build
+
+    # Deploy to the github-pages environment.
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      # Deploy documentation (github-pages artifact by default) to Github Pages.
+      - name: Deploy Docs Artifact to Github Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -2,4 +2,7 @@
 /phpunit.xml
 /vendor
 /.idea
-/.phpunit.result.cache
+/.phpunit.result.cache
+/node_modules
+/docs/.vitepress/cache
+/docs/.vitepress/dist

docs/.vitepress/config.js

@@ -0,0 +1,68 @@
+export default {
+    title: "Laravel AdminLTE",
+    description: "Easy AdminLTE integration with Laravel",
+    lastUpdated: true,
+    base: '/Laravel-AdminLTE',
+    themeConfig: {
+        logo: '/imgs/AdminLTELogo.ico',
+        sidebar: [
+            {
+                text: 'Overview',
+                collapsed: false,
+                items: [
+                    { text: 'Home', link: '/' },
+                    { text: 'Requirements', link: '/sections/overview/requirements' },
+                    { text: 'Installation', link: '/sections/overview/installation' },
+                    { text: 'Updating', link: '/sections/overview/updating' },
+                    { text: 'Usage', link: '/sections/overview/usage' },
+                    { text: 'Authentication Views', link: '/sections/overview/authentication_views' },
+                    { text: 'Artisan commands', link: '/sections/overview/artisan_console_commands' }
+                ]
+            }, {
+                text: 'Configuration',
+                collapsed: false,
+                items: [
+                    { text: 'Basic configuration', link: '/sections/configuration/basic_configuration' },
+                    { text: 'Layout & styling', link: '/sections/configuration/layout_and_styling' },
+                    { text: 'Menu ', link: '/sections/configuration/menu' },
+                    { text: 'Special menu items', link: '/sections/configuration/special_menu_items' },
+                    { text: 'Plugins', link: '/sections/configuration/plugins' },
+                    { text: 'Misc config', link: '/sections/configuration/other' },
+                    { text: 'Translations', link: '/sections/configuration/translations' },
+                    { text: 'Views customization', link: '/sections/configuration/views_customization' },
+                    { text: 'IFrame mode', link: '/sections/configuration/iframe_mode' }
+                ]
+            }, {
+                text: 'Components',
+                collapsed: false,
+                items: [
+                    { text: 'Intro & Categories', link: '/sections/components/components_categories' },
+                    { text: 'Basic form components', link: '/sections/components/basic_forms_components' },
+                    { text: 'Advanced form components', link: '/sections/components/advanced_forms_components' },
+                    { text: 'Tool components', link: '/sections/components/tool_components' },
+                    { text: 'Widget components', link: '/sections/components/widget_components' },
+                    { text: 'Components customization', link: '/sections/components/components_customization' }
+                ]
+            }, {
+                text: 'Contribution & Extras',
+                collapsed: true,
+                items: [
+                    { text: 'Issues & Pull Request', link: '/sections/contribution_and_extras/issues_questions_and_pull_requests' },
+                    { text: 'Related Packages', link: '/sections/contribution_and_extras/related_packages' }
+                ]
+            }
+        ],
+        socialLinks: [
+            { icon: 'github', link: 'https://github.com/jeroennoten/Laravel-AdminLTE' }
+        ],
+        search: {
+            provider: 'local'
+        }
+    },
+    head: [
+        [
+            'link',
+            { rel: 'icon', href: '/Laravel-AdminLTE/imgs/AdminLTELogo.ico' }
+        ]
+    ]
+};

docs/index.md

@@ -0,0 +1,14 @@
+# Easy AdminLTE integration with Laravel
+
+This package provides an easy way to quickly set up [AdminLTE v3](https://adminlte.io/themes/v3/) with [Laravel](https://laravel.com/) (7 or higher). It has no other requirements and dependencies besides **Laravel**, so you can start building your admin panel immediately. The package provides a [blade template](https://laravel.com/docs/blade) that you can extend and an advanced menu configuration system. Also, and optionally, the package offers a set of **AdminLTE** styled authentication views that you can use in replacement of the ones that are provided by the legacy [laravel/ui](https://github.com/laravel/ui) authentication scaffolding.
+
+If you want to use an older **Laravel** or **AdminLTE** version, review the following package releases:
+- **Releases 1.x**:
+  These releases supports Laravel 5 and include AdminLTE v2
+- **Releases 2.x**:
+  These releases supports Laravel 6 and include AdminLTE v2
+- **Releases 3.x <Badge type="tip"><= v3.8.6</Badge>**:
+  These releases supports Laravel 6 and include AdminLTE v3
+
+> [!Important]
+> Only the version **3.x** of this package is currently maintained, so be aware that older versions are unmaintained and you'll have to use as they are.