Build website with HydePHP

.github/workflows/build.yml

@@ -69,15 +69,59 @@ jobs:
       - name: Lint code.
         run: ansible-lint .
 
+  website:
+    name: Build website
+    needs: ansible-lint
+    defaults:
+      run:
+        working-directory: ./files/website
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the codebase.
+        uses: actions/checkout@v2
+
+      - name: Install Composer dependencies.
+        uses: php-actions/composer@v6
+        with:
+          working_dir: ./files/website
+
+      - name: Build the templates.
+        run: php hyde build
+
+      - name: Install Node.js.
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.0.0
+
+      - name: Install NPM dependencies.
+        run: npm install
+
+      - name: Build assets.
+        run: npm run prod
+
+      - name: Upload website artifact.
+        uses: actions/upload-artifact@v4
+        with:
+          name: website
+          path: files/website/_site
+          retention-days: 1
+
   molecule:
     name: Molecule
-    needs: ansible-lint
+    needs: website
     runs-on: ubuntu-22.04
 
     steps:
       - name: Check out the codebase.
         uses: actions/checkout@v2
 
+      - name: Download website artifact.
+        uses: actions/download-artifact@v4
+        with:
+          name: website
+          path: files/website/_site
+
       - name: Set up Python 3.
         uses: actions/setup-python@v2
         with:

.github/workflows/deploy.yml

@@ -29,32 +29,76 @@ name: Deploy
       - master
 
 jobs:
-  ansible-playbook:
-    name: Run playbook
+  website:
+    name: Build website
+    defaults:
+      run:
+        working-directory: ./files/website
     runs-on: ubuntu-22.04
 
     steps:
-      - name: Check out the codebase.
+      - name: Checkout the codebase
         uses: actions/checkout@v2
 
-      - name: Set up Python 3.
+      - name: Install Composer dependencies
+        uses: php-actions/composer@v6
+        with:
+          working_dir: ./files/website
+
+      - name: Build the templates
+        run: php hyde build
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.0.0
+
+      - name: Install NPM dependencies
+        run: npm install
+
+      - name: Build assets
+        run: npm run prod
+
+      - name: Upload website artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: website_to_deploy
+          path: files/website/_site
+          retention-days: 1
+
+  ansible:
+    name: Run Ansible playbook
+    needs: website
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Check out the codebase
+        uses: actions/checkout@v2
+
+      - name: Download website artifact.
+        uses: actions/download-artifact@v4
+        with:
+          name: website_to_deploy
+          path: files/website/_site
+
+      - name: Set up Python 3
         uses: actions/setup-python@v2
         with:
           python-version: "3.x"
 
-      - name: Install Ansible.
+      - name: Install Ansible
         run: pip3 install ansible
 
       - name: Install playbooks dependencies
         run: ansible-galaxy role install --role-file requirements.yml
 
-      - name: Install SSH key.
+      - name: Install SSH key
         uses: shimataro/ssh-key-action@v2
         with:
           key: ${{ secrets.SSH_PRIVATE_KEY }}
           known_hosts: ${{ secrets.KNOWN_HOSTS }}
 
-      - name: Run plays.
+      - name: Run plays
         run: >
           ansible-playbook main.playbook.yml
           --inventory ${{ secrets.ANSIBLE_INVENTORY }},

files/website/.env.example

@@ -0,0 +1,8 @@
+# If you have a domain, you should set the URL here so that permalinks can be generated.
+# SITE_URL=https://example.org
+
+# If you want to use Torchlight.dev, enter your API token here to automatically enable it
+# TORCHLIGHT_TOKEN=torch_
+
+# If you want to change the default port of the realtime compiler server, you can do so here
+# SERVER_PORT=8080

files/website/.gitattributes

@@ -0,0 +1,13 @@
+* text eol=lf
+
+*.blade.php diff=html
+*.css diff=css
+*.html diff=html
+*.md diff=markdown
+*.php diff=php
+
+.github/ export-ignore
+tests/ export-ignore
+CHANGELOG.md export-ignore
+LICENSE.md export-ignore
+SECURITY.md export-ignore

files/website/.gitignore

@@ -0,0 +1,12 @@
+/vendor
+/node_modules
+/builds
+/.idea
+/.vscode
+/.vagrant
+/.cache
+.phpunit.result.cache
+
+.env
+
+/_site

files/website/README.md

@@ -0,0 +1,106 @@
+# HydePHP - Elegant and Powerful Static Site Generator
+
+[![Latest Version on Packagist](https://img.shields.io/packagist/v/hyde/framework?include_prereleases)](https://packagist.org/packages/hyde/framework)
+[![Total Downloads on Packagist](https://img.shields.io/packagist/dt/hyde/framework)](https://packagist.org/packages/hyde/framework)
+[![License MIT](https://img.shields.io/github/license/hydephp/hyde) ](https://github.com/hydephp/hyde/blob/master/LICENSE.md)
+[![Test Coverage](https://codecov.io/gh/hydephp/develop/branch/master/graph/badge.svg?token=G6N2161TOT)](https://codecov.io/gh/hydephp/develop)
+[![Test Suite](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/hydephp/develop/actions/workflows/continuous-integration.yml)
+
+
+## Make static websites, blogs, and documentation pages with the tools you already know and love.
+
+### About HydePHP
+
+HydePHP is a content-first Laravel-powered console application that allows you to create static HTML pages, blog posts, and documentation sites,
+using your choice of Markdown and/or Blade.
+
+Build sites in record-time with a full batteries-included TailwindCSS frontend that just works without any fuzz.
+
+### Speed & simplicity first, full control when you need it.
+
+Hyde is all about letting you get started quickly by giving you a full-featured frontend starter kit, while also giving you the power and freedom of doing things the way you want to.
+
+Markdown purist? That's all you need. Blade artisan? Go for it.
+Hyde comes with hand-crafted frontend templates, so you can focus on your content.
+You don't _need_ to customize anything. But you _can_ customize everything.
+
+See the documentation and learn more at https://hydephp.com/docs
+
+
+## Features
+
+### Content Creation
+
+- Create blog posts using Markdown and Front Matter.
+- Create documentation pages from plain Markdown, no front matter needed!
+- Create simple pages using Markdown, or create advanced ones using Laravel Blade.
+- You can scaffold blog posts and Markdown pages to automatically fill in the front matter.
+- You can also scaffold Blade pages to automatically use the default layout.
+
+### Built-in Frontend
+
+- Hyde comes with a TailwindCSS starter kit, so you can start making content right away.
+- The starter kit is fully responsive, has a dark mode theme, and is customizable.
+- The frontend is accessible to screen-readers and rich with semantic HTML and microdata.
+- Hyde automatically chooses the right layout to use depending on the content being rendered.
+- Hyde also fills in and creates content like navigation menus and sidebars automatically.
+
+### Easy Asset Managing
+
+- The Hyde starter comes with [HydeFront](https://github.com/hydephp/hydefront) to serve the base stylesheet and JavaScript through the jsDelivr CDN.
+- Hyde ships with precompiled and minified TailwindCSS styles in the app.css file, you can also load them through the CDN.
+- This means that all the styles you need are already installed. However, if you want to customize the included Tailwind config, or if you add new Tailwind classes through Blade files, you can simply run the `npm run dev` command to recompile the styles using the pre-configured Laravel Mix package.
+
+### Customization
+
+- You don't need to configure anything as Hyde is shipped with sensible defaults.
+- You can, however, customize nearly everything. Here are just a few out of many examples:
+- All frontend components and page layouts are created with Blade, so you
+  can publish the vendor views, just like in Laravel.
+- Override many of the dynamic content features like the menus and footer.
+
+
+## Getting Started - High-level overview
+
+> See [Installation Guide](https://hydephp.com/docs/1.x/installation) and [Getting Started](https://hydephp.com/docs/1.x/getting-started) for the full details.
+
+It's a breeze to get started with Hyde. Create a new Hyde project using Composer:
+
+```bash
+composer create-project hyde/hyde
+```
+
+Next, place your Markdown files in one of the content directories:  `_posts`, `_docs`, and `_pages` which also accepts Blade files. You can also use the `hyde:make` commands to scaffold them.
+
+When you're ready, run the build command to compile your static site which will save your HTML files in the `_site` directory.
+
+```bash
+php hyde build
+```
+
+
+## Resources
+
+### Changelog
+
+Please see [CHANGELOG](https://github.com/hydephp/develop/blob/master/CHANGELOG.md) for more information on what has changed recently.
+
+### Contributing
+
+HydePHP is an open-source project, contributions are very welcome!
+
+Development is made in the HydePHP Monorepo, which you can find here https://github.com/hydephp/develop.
+
+### Security
+
+If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
+All vulnerabilities will be promptly addressed.
+
+### Credits
+
+-   [Caen De Silva](https://github.com/caendesilva), feel free to buy me a coffee! https://www.buymeacoffee.com/caen
+-   [All Contributors](../../contributors)
+
+### License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.