Add pages.yml for prettier docs

.github/workflows/pages.yml

@@ -0,0 +1,71 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "docs/**"
+
+  # 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
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+          working-directory: '${{ github.workspace }}/docs'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "docs/_site/"
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -16,7 +16,7 @@ Translation Checker provides several commands to manage your translations. The m
 ```bash
 php artisan translations:check en 
 ```
-For detailed information on all available commands and their usage, refer to the [documentation](https://github.com/bottelet/translation-checker/docs).
+For detailed information on all available commands and their usage, refer to the [documentation](https://bottelet.github.io/translation-checker/).
 
 ## Testing
 
@@ -28,7 +28,7 @@ Run the tests with:
 
 ## Documentation
 
-For full documentation, visit our [GitHub documentation page](https://github.com/bottelet/translation-checker/docs).
+For full documentation, visit our [GitHub documentation page](https://bottelet.github.io/translation-checker/).
 
 If you encounter any issues or have suggestions, please create an issue on GitHub.
 

docs/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem "jekyll", "~> 4.3.3"
+gem "just-the-docs"

docs/_config.yml

@@ -0,0 +1,5 @@
+title: Translations checker for Laravel
+description: Help you find translations you forgot to add to your language files,
+theme: just-the-docs
+
+url: https://bottelet.github.io/translation-checker/

docs/index.md

@@ -1,11 +1,17 @@
+---
+layout: default
+title: Getting Started
+nav_enabled: true
+---
+
 # Translation Checker
 Translation Checker is tool designed to help you find translations you forgot to add to your language files, check, and maintain translations in your project. It provides a set of commands to help with language files, ensuring consistency and completeness across your translations.
 
 It works with Laravel and supports various frontend frameworks like Vue.js, React, and Svelte.
 
 and as default looks for translations in the `app/` and `resources/` folders.
 ## Installation
-You can install the package via composer:
+You can install the package via composer: 
 
 ```bash
 composer require bottelet/laravel-translation-checker