v2.0.0 (#33)

* chore(docs): Update license
* chore(docs): Update README
* chore(docs): Update README links
* enhance(docs): Add instructions for installing as a plugin
* enhance(docs): Add usage example for vanilla themes
* enhance(docs): Improve documentation custom field examples (Supersedes #27)
* enhance(docs): Move theme usage into `examples/` folder
* feat(ci): Add GitHub action to package Navi as a plugin
* feat(ci): Switch to GitHub actions
* feat(navi): Add support for WPML (Fixes #18)
* feat(navi): Allow Navi to be used as a plugin
* feat(navi): Lower minimum PHP version to 7.0
* feat(navi): Remove dependency on Roots Sage
* feat(navi): Remove Illuminate dependencies (Supersedes #20)

.gitattributes

@@ -1,3 +1,3 @@
 /.gitattributes export-ignore
 /.github export-ignore
-/.circleci export-ignore
+/examples export-ignore

.github/workflows/compatibility.yml

@@ -0,0 +1,43 @@
+name: compatibility
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  compatibility:
+    name: PHP ${{ matrix.php-versions }} on ${{ matrix.operating-system }}
+    runs-on: ${{ matrix.operating-system }}
+    if: "!contains(github.event.head_commit.message, '[ci skip]')"
+    strategy:
+      matrix:
+        operating-system: [ubuntu-latest]
+        php-versions: ["7.0", "7.4", "8.0"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          coverage: xdebug
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get composer cache directory
+        id: composercache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - uses: actions/cache@v2
+        with:
+          path: ${{ steps.composercache.outputs.dir }}
+          key: ${{ runner.os }}-${{ matrix.php-versions }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-${{ matrix.php-versions }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader --no-suggest
+
+      - name: PHP lint
+        run: composer run-script lint

.github/workflows/main.yml

@@ -0,0 +1,34 @@
+name: main
+
+on: [pull_request]
+
+jobs:
+  main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "7.0"
+          coverage: xdebug
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get composer cache directory
+        id: composercache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - uses: actions/cache@v2
+        with:
+          path: ${{ steps.composercache.outputs.dir }}
+          key: ${{ runner.os }}-7.0.x-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-7.0.x-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader --no-suggest
+
+      - name: PHP lint
+        run: composer run-script lint

.github/workflows/release.yml

@@ -0,0 +1,52 @@
+name: release
+
+on:
+  push:
+    tags:
+      - "*"
+
+jobs:
+  release:
+    name: Publish release
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP, with composer and extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: "7.0"
+          coverage: xdebug
+        env:
+          COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader --no-suggest --no-dev
+
+      - name: Cleanup unnecessary files
+        run: rm -rf .git .github .editorconfig .gitattributes .gitignore composer.json composer.lock examples
+
+      - name: Get the version
+        id: get_version
+        run: echo ::set-output name=version::${GITHUB_REF/refs\/tags\//}
+        shell: bash
+
+      - name: Create subfolder
+        run: mkdir navi && mv ./* navi/ 2>/dev/null
+        continue-on-error: true
+
+      - name: Create distributable zip file
+        uses: montudor/[email protected]
+        with:
+          args: zip -qq -r9 navi.zip navi
+
+      - name: Upload zip as release asset
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: navi.zip
+          asset_name: navi-${{ steps.get_version.outputs.version }}.zip
+          tag: ${{ github.ref }}
+          overwrite: true

.gitignore

@@ -1 +1 @@
-vendor
+/vendor

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Brandon Nifong
+Copyright (c) Brandon Nifong
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal