Skip to content

Commit

Permalink
Document webserver deployment for #929 (#932)
Browse files Browse the repository at this point in the history
  • Loading branch information
gavinband authored Dec 9, 2021
1 parent 8df2fa6 commit 65c3bde
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion docs/workflow/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,19 @@ reviewed: 18/10/20

\lineskip

Deploying the website is trivial on GitHub, Gitlab and services like Netlify.
Deploying the website is trivial on an existing webserver, via GitHub or Gitlab, or on services like Netlify.

## Deploying on an existing webserver

The contents of the `__site` folder can simply be deployed to a path on an existing server as follows.
Supposing you wish your site to appear at `http://my.example.com/path/to/my/franklin/site/`. You would take the following steps:

* Prepare the `__site` directory by running `optimize( prepath='/path/to/my/franklin/site/', minify = false )`.
Franklin.jl does not use relative links, so this step is needed to ensure that the links between site elements are correct. (The `minify = false` argument is optional but is currently recommended.)

* Copy the contents of the `__site` directory to the target location using your chosen method (for example, using [rsync](https://en.wikipedia.org/wiki/Rsync)).

Your site should now be live, with the index page appearing at `http://my.example.com/path/to/my/franklin/site/index.html`.

## Deploying on GitHub

Expand Down

0 comments on commit 65c3bde

Please sign in to comment.