Skip to content

Commit

Permalink
Add deployment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
caendesilva committed May 19, 2022
1 parent baadd48 commit 4b188f2
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion .github/dev-docs/building-your-site.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
priority: 25
label: "Compiling to HTML"
label: "Compile & Deploy"
category: "Creating Content"
---

Expand Down Expand Up @@ -31,6 +31,42 @@ php hyde serve
- [Rebuild command](console-commands#build-a-single-file)
- [Serve command](console-commands#start-the-realtime-compiler)

## Deploying your site

One of the things that make static sites so enjoyable to work with is how easy it is to deploy them to the web.
This list is not exhaustive, but gives you a general idea of the most common ways to deploy your site.
If you have ideas to add to the documentation, please send a pull request!

### General deployment

In essence, all you need to do is copy the contents of the `_site` directory to a web server and you're done.

Once the site is compiled there is nothing to configure or worry about.

### FTP and File Managers

If you have a conventional web host, you can use FTP/SFTP/FTPS to upload your site to the web server.
Some web hosting services also have web based file managers.

To deploy your site using any of these methods, all you need to do is upload the entire contents
of your `_site` directory to the web server, usually in the `public_html`, `htdocs`, or `www` directory.

### GitHub Pages - Manually

GitHub Pages is a free service that allows you to host your static site on the web.

Please see the [GitHub Pages documentation](https://help.github.com/pages/getting-started-with-github-pages/) for more information.

### GitHub Pages - CI/CD

Hyde works amazing with GitHub Pages and GitHub Actions and the entire build and deploy process can be automated.

HydePHP.com is hosted on GitHub Pages, and the site is compiled in a GitHub Action workflow that compiles and
deploys the site automatically when the source is updated. This is done in the [DocsCI repository](https://github.com/hydephp/DocsCI).

You can take a look at the workflow HydePHP.com uses to create your own workflow.
[DocsCI build.yml on GitHub](https://github.com/hydephp/DocsCI/blob/master/.github/workflows/build.yml)


## Concepts

Expand Down

0 comments on commit 4b188f2

Please sign in to comment.