Migrated documentation to Hugo

Signed-off-by: RJ Garcia <ragboyjr@icloud.com>
khagesh4 · Dec 24, 2020 · 69f5bf7 · 69f5bf7
1 parent 976d1ab
commit 69f5bf7
Show file tree

Hide file tree

Showing 45 changed files with 349 additions and 595 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,7 @@
 build
 composer.lock
 vendor
-doc/_site
-doc/_data/versions.yml
+doc/public
+doc/data/versions.json
 .generated
+.phpunit.result.cache
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,4 +19,11 @@ We accept contributions via Pull Requests on [Github](https://github.com/thephpl
 ``` bash
 $ phpunit
 ```
+
+## Docs
+
+Docs are served with hugo running on version 0.79 or later.
+
+You can view the docs locally with `hugo -s doc server`
+
 **Happy coding**!
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ Please see [CONTRIBUTING](https://github.com/thephpleague/plates/blob/master/CON
 
 ## Security
 
-If you discover any security related issues, please email rj@bighead.net instead of using the issue tracker.
+If you discover any security related issues, please email ragboyjr@icloud.com instead of using the issue tracker.
 
 ## Credits
 

diff --git a/composer.json b/composer.json
@@ -18,7 +18,7 @@
         },
         {
             "name": "RJ Garcia",
-            "email": "rj@bighead.net",
+            "email": "ragboyjr@icloud.com",
             "role": "Developer"
         }
     ],
@@ -46,6 +46,7 @@
         }
     },
     "scripts": {
-        "test": "phpunit"
+        "test": "phpunit --testdox",
+        "docs": "hugo -s doc server"
     }
 }
diff --git a/doc/Gemfile b/doc/Gemfile
diff --git a/doc/Gemfile.lock b/doc/Gemfile.lock
diff --git a/doc/_data/images.yml b/doc/_data/images.yml
diff --git a/doc/_data/menu.yml b/doc/_data/menu.yml
diff --git a/doc/_data/project.yml b/doc/_data/project.yml