diff --git a/docs/workflow/deploy.md b/docs/workflow/deploy.md index 9f8a1c32b..186952a0e 100644 --- a/docs/workflow/deploy.md +++ b/docs/workflow/deploy.md @@ -227,14 +227,18 @@ Finally, we want to deploy the main website and the PR preview on different bran Now to avoid problems with the subfolder structure of our website we need to make a small change to our `config.md` file. Change the following lines -```julia -@def prepath = "myprepath" # This is possibly "" for your case -@def website_url = "mywebsite.github.io" +```markdown ++++ +prepath = "myprepath" # This is possibly "" for your case +website_url = "mywebsite.github.io" ++++ ``` to -```julia -@def prepath = get(ENV, "PREVIEW_FRANKLIN_PREPATH", "myprepath") # In the third argument put the prepath you normally use -@def website_url = get(ENV, "PREVIEW_FRANKLIN_WEBSITE_URL", "mywebsite.github.io") # Just put the website name +```markdown ++++ +@prepath = get(ENV, "PREVIEW_FRANKLIN_PREPATH", "myprepath") # In the third argument put the prepath you normally use +@website_url = get(ENV, "PREVIEW_FRANKLIN_WEBSITE_URL", "mywebsite.github.io") # Just put the website name ++++ ``` Now for the final step, you will need to visualize the obtained previews. @@ -290,14 +294,18 @@ Finally, we want to deploy the main website and the PR preview on the same branc Now to avoid problems with the subfolder structure of our website we need to make a small change to our `config.md` file. Change the following lines -```julia -@def prepath = "myprepath" # This is possibly "" for your case -@def website_url = "mywebsite.github.io" +```markdown ++++ +prepath = "myprepath" # This is possibly "" for your case +website_url = "mywebsite.github.io" ++++ ``` to -```julia -@def prepath = get(ENV, "PREVIEW_FRANKLIN_PREPATH", "myprepath") # In the third argument put the prepath you normally use -@def website_url = get(ENV, "PREVIEW_FRANKLIN_WEBSITE_URL", "mywebsite.github.io") # Just put the website name +```markdown ++++ +prepath = get(ENV, "PREVIEW_FRANKLIN_PREPATH", "myprepath") # In the third argument put the prepath you normally use +website_url = get(ENV, "PREVIEW_FRANKLIN_WEBSITE_URL", "mywebsite.github.io") # Just put the website name ++++ ``` Once everything is set up you will be able to visualize your PR preview on `{github username}.github.io/previews/PR{number of your PR}`. diff --git a/docs/workflow/index.md b/docs/workflow/index.md index ad88f6369..8d6349bfb 100644 --- a/docs/workflow/index.md +++ b/docs/workflow/index.md @@ -199,8 +199,10 @@ See `?publish` for more information. In any case, before deploying, if you're working on a _project website_ i.e. a website whose root URL will look like `username.gitlab.io/project/` then you should add the following line in your `config.md` file: -```julia -@def prepath = "project" +```markdown ++++ +prepath = "project" ++++ ``` the `publish` function will then ensure that all links are fixed before deploying your website.