Browse Source

simpler publishing instructions

Heydon Pickering 8 years ago
parent
commit
092b9a9d13
2 changed files with 12 additions and 7 deletions
  1. 12 6
      content/patterns/serving.md
  2. 0 1
      node/toPDF.js

+ 12 - 6
content/patterns/serving.md

@@ -13,11 +13,7 @@ This will serve your working library from `localhost:1313`. Whenever you make ch
 
 ## Publishing on Github Pages
 
-**Infusion** creates a `/docs` folder containing the latest version of your library whenever you do an `npm run build` or a `git commit`. This folder can be made the source for your Github Pages site by selecting it under  **Settings → Github Pages → Source** in the web interface.
-
-![The publishing source dropdown menu on Github](/images/serve_from_docs.png)
-
-Then, whenever you push to master, you will also be updating the site found at your Github Pages URL.
+**Infusion** creates a `/docs` folder containing the latest version of your library whenever you do an `npm run build` or a `git commit`. So long as you forked the **Infusion** repository when making your own library (see {{% pattern "Library setup" %}}), whenever you push to master, you will also be updating the site found at your Github Pages URL.
 
 This URL will be in the following format:
 
@@ -25,4 +21,14 @@ This URL will be in the following format:
 [your user name].github.io/[your library repo name]
 ```
 
-You'll also need to add it to your `config.toml` file as the `baseURL` value. See {{% pattern "Library setup" %}} for more information.
+You'll also need to add this value to your `config.toml` file as the `baseURL`. For **Infusion**'s own documentation it looks like the following. Just overwrite it.
+
+```
+baseURL = "https://thepaciellogroup.github.io/infusion/"
+```
+
+{{% note %}}
+If you created a new library repo manually (without forking) you will find the `docs` folder is not automatically setup as the publishing source. This folder can be made the source for your Github Pages site by selecting it under  **Settings → Github Pages → Source** in the web interface.
+
+![The publishing source dropdown menu on Github](/images/serve_from_docs.png)
+{{% /note %}}

+ 0 - 1
node/toPDF.js

@@ -1 +0,0 @@
-// stub