VerifiedJoseph · hazzuk · May 8, 2024 · May 8, 2024 · May 8, 2024 · May 8, 2024
diff --git a/README.md b/README.md
@@ -1,20 +1,31 @@
+<p align="left">
+  <a href="https://hazzuk.github.io/vigilant/">
+    <img src="https://hazzuk.github.io/vigilant/_media/logo/vigilant.png" width="110px" alt="Vigilant logo">
+  </a>
+</p>
+
 # Vigilant
 
 [![Latest Version](https://img.shields.io/github/release/VerifiedJoseph/vigilant.svg?style=flat-square)](https://github.com/VerifiedJoseph/vigilant/releases/latest)
 [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
 
 Vigilant is a PHP script for monitoring RSS/ATOM and JSON feeds, and sending push notifications on new entries.
 
-Vigilant supports sending push notifications with [Gotify](https://gotify.net) or [ntfy.sh](https://ntfy.sh).
+Supports sending push notifications with [Gotify](https://gotify.net) or [ntfy.sh](https://ntfy.sh).
+
+Vigilant can either be run manually or in a Docker container, making it quick and easy to deploy.
 
 ## Documentation
 
-- [Installation](docs/install.md)
-- [Configuration](docs/configuration.md)
-- [Feeds File](docs/feeds.md)
+- 📥[Installation](docs/install.md)
+- ⚙️[Configuration](docs/configuration.md)
+- 📝[Feeds File](docs/feeds.md)
 
 ## Requirements
 
+🐳Docker
+
+Or for manual setup:
 - PHP >= 8.2
 - Composer
 - PHP Extensions:
@@ -38,4 +49,4 @@ All notable changes to this project are documented in the [CHANGELOG](CHANGELOG.
 
 ## License
 
-MIT License. Please see [LICENSE](LICENSE) for more information.
+MIT License. Please see [LICENSE](https://github.com/VerifiedJoseph/vigilant/blob/main/LICENSE) for more information.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1 @@
+../README.md
diff --git a/docs/_404.md b/docs/_404.md
@@ -0,0 +1 @@
+<h1>404 - Not found</h1>
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
@@ -0,0 +1,15 @@
+![logo](_media/logo/vigilant-icon.svg)
+
+# Vigilant
+
+[![Latest Version](https://img.shields.io/github/release/VerifiedJoseph/vigilant.svg?style=flat-square)](https://github.com/VerifiedJoseph/vigilant/releases/latest)
+[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)
+
+> An RSS/ATOM/JSON feed monitor with push notifications
+
+- Simple and lightweight
+- Push notifications with [Gotify](https://gotify.net) or [ntfy.sh](https://ntfy.sh)
+- Deploy as a Docker container
+
+[Get Started](README.md)
+[↗️ GitHub](https://github.com/VerifiedJoseph/vigilant/)
diff --git a/docs/_media/logo/vigilant-icon.svg b/docs/_media/logo/vigilant-icon.svg
diff --git a/docs/_media/logo/vigilant.png b/docs/_media/logo/vigilant.png
diff --git a/docs/_media/logo/vigilant.svg b/docs/_media/logo/vigilant.svg
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,6 @@
+* [Vigilant](README.md)
+* [📥Installation](install.md)
+* [⚙️Configuration](configuration.md)
+* [📝Feeds File](feeds.md)
+* [🗓️Changelog](CHANGELOG.md)
+* [↗️ GitHub](https://github.com/VerifiedJoseph/vigilant/)
diff --git a/docs/docsify.md b/docs/docsify.md
@@ -0,0 +1,20 @@
+<p align="left">
+  <a href="https://docsify.js.org/">
+    <img src="https://docsify.js.org/_media/icon.svg" width="100" alt="Docsify logo">
+  </a>
+</p>
+
+# Documentation powered by Docsify
+
+### Follow the Docsify '[Quick start](https://docsify.js.org/#/quickstart)' guide on how to install and run it locally.
+
+1. Install Docsify `npm i docsify-cli -g`.
+
+2. At root of the repo `docsify serve docs`.
+
+3. Set `basePath: '/',` in `index.html` for localhost website, revert when finished.
+
+
+### Read the Docsify '[Deploy](https://docsify.js.org/#/deploy)' guide on how to deploy the documentation to GitHub Pages.
+
+- Select `main branch /docs folder` as your GitHub Pages source.
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,44 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>Vigilant</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="PHP script for monitoring RSS/ATOM/JSON feeds and sending push notifications on new entries.">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+ <!-- Themes (light + dark) -->
+ <link rel="stylesheet" media="(prefers-color-scheme: dark)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css">
+ <link rel="stylesheet" media="(prefers-color-scheme: light)" href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css">
+ <link rel="icon" type="image/x-icon" href="/vigilant/_media/logo/vigilant.png">
+</head>
+
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'Vigilant',
+      basePath: '/vigilant/',
+      logo: '_media/logo/vigilant-icon.svg',
+      coverpage: true,
+      onlyCover: true,
+      loadSidebar: true,
+      auto2top: true,
+      subMaxLevel: 2,
+      alias: {
+        '/docs/(.*)': '$1',
+        '/CHANGELOG(.*)': 'https://raw.githubusercontent.com/VerifiedJoseph/vigilant/master/CHANGELOG'
+      }
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <!-- Required -->
+  <script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/js/docsify-themeable.min.js"></script>
+  <!-- Recommended -->
+  <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/search.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/docsify@4/lib/plugins/zoom-image.min.js"></script>
+
+</body>
+
+</html>