Document webserver deployment for #929 #932
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tlienart
reviewed
Dec 8, 2021
docs/workflow/deploy.md
Outdated
|
|
||
| ## Deploying on an existing webserver | ||
|
|
||
| The contents of the `__site__` folder can simply be deployed to a path on an existing server as follows. |
docs/workflow/deploy.md
Outdated
| 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 )`. |
docs/workflow/deploy.md
Outdated
| * 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. |
There was a problem hiding this comment.
maybe here after method you could add (e.g. using rsync)
|
Great, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here's a first go at this - please use / edit as needed.