diff --git a/config.toml b/config.toml index ba2f5a3..b8b18c7 100644 --- a/config.toml +++ b/config.toml @@ -3,6 +3,7 @@ title = "Infusion" baseURL = "https://heydon.github.io/infusion/" canonifyURLs = true theme = "infusion" +publishDir = "docs" [params] description = "Documentation for the Infusion pattern library builder. This documentation is constructed using the builder itself." diff --git a/content/patterns/serving.md b/content/patterns/serving.md index 7cba17c..db82f81 100644 --- a/content/patterns/serving.md +++ b/content/patterns/serving.md @@ -8,7 +8,7 @@ While you're creating content for your library, you'll probably want to see what {{}}npm run serve{{}} -This will serve your working library on `localhost:1313`. Whenever you make changes to your library's files, the site will automatically rebuild. No need to refresh the web page! +This will serve your working library from `localhost:1313` (the exact URL will be determined by what's in your `baseURL` and will be revealed to you by your terminal). Whenever you make changes to your library's files, the site will automatically rebuild. No need to refresh the web page! ## Publishing on Github Pages diff --git a/public/categories/index.xml b/docs/categories/index.xml similarity index 100% rename from public/categories/index.xml rename to docs/categories/index.xml diff --git a/public/css/images/icon-tick.svg b/docs/css/images/icon-tick.svg similarity index 100% rename from public/css/images/icon-tick.svg rename to docs/css/images/icon-tick.svg diff --git a/public/css/images/stripe.svg b/docs/css/images/stripe.svg similarity index 100% rename from public/css/images/stripe.svg rename to docs/css/images/stripe.svg diff --git a/public/css/prism.css b/docs/css/prism.css similarity index 100% rename from public/css/prism.css rename to docs/css/prism.css diff --git a/public/css/styles.css b/docs/css/styles.css similarity index 100% rename from public/css/styles.css rename to docs/css/styles.css diff --git a/public/images/icon-info.svg b/docs/images/icon-info.svg similarity index 100% rename from public/images/icon-info.svg rename to docs/images/icon-info.svg diff --git a/public/images/icon-tag.svg b/docs/images/icon-tag.svg similarity index 100% rename from public/images/icon-tag.svg rename to docs/images/icon-tag.svg diff --git a/public/images/icon-warning.svg b/docs/images/icon-warning.svg similarity index 100% rename from public/images/icon-warning.svg rename to docs/images/icon-warning.svg diff --git a/public/images/logo.png b/docs/images/logo.png similarity index 100% rename from public/images/logo.png rename to docs/images/logo.png diff --git a/public/images/open_in_desktop.png b/docs/images/open_in_desktop.png similarity index 100% rename from public/images/open_in_desktop.png rename to docs/images/open_in_desktop.png diff --git a/public/images/steve_faulkner.jpg b/docs/images/steve_faulkner.jpg similarity index 100% rename from public/images/steve_faulkner.jpg rename to docs/images/steve_faulkner.jpg diff --git a/public/index.html b/docs/index.html similarity index 100% rename from public/index.html rename to docs/index.html diff --git a/public/index.xml b/docs/index.xml similarity index 97% rename from public/index.xml rename to docs/index.xml index 38d9c33..ab9d768 100644 --- a/public/index.xml +++ b/docs/index.xml @@ -134,8 +134,7 @@ I can reference the {{% pattern "Notes & warnings" %}} patt https://heydon.github.io/infusion/patterns/serving/ Serving locally While you’re creating content for your library, you’ll probably want to see what the finished product looks like. Fortunately, Infusion is easy to serve locally using the serve command: -npm run serve This will serve your working library on localhost:1313. Whenever you make changes to your library’s files, the site will automatically rebuild. No need to refresh the web page! -Publishing on Github Pages There are three steps to hosting your library on Github Pages. +npm run serve This will serve your working library from localhost:1313 (the exact URL will be determined by what’s in your baseURL and will be revealed to you by your terminal). Whenever you make changes to your library’s files, the site will automatically rebuild. diff --git a/public/js/dom-scripts.js b/docs/js/dom-scripts.js similarity index 100% rename from public/js/dom-scripts.js rename to docs/js/dom-scripts.js diff --git a/public/js/prism.js b/docs/js/prism.js similarity index 100% rename from public/js/prism.js rename to docs/js/prism.js diff --git a/public/js/webcomponents.js b/docs/js/webcomponents.js similarity index 100% rename from public/js/webcomponents.js rename to docs/js/webcomponents.js diff --git a/public/patterns/code/code-blocks/index.html b/docs/patterns/code/code-blocks/index.html similarity index 100% rename from public/patterns/code/code-blocks/index.html rename to docs/patterns/code/code-blocks/index.html diff --git a/public/patterns/code/codepen-embedding/index.html b/docs/patterns/code/codepen-embedding/index.html similarity index 100% rename from public/patterns/code/codepen-embedding/index.html rename to docs/patterns/code/codepen-embedding/index.html diff --git a/public/patterns/code/color-palettes/index.html b/docs/patterns/code/color-palettes/index.html similarity index 100% rename from public/patterns/code/color-palettes/index.html rename to docs/patterns/code/color-palettes/index.html diff --git a/public/patterns/code/index.html b/docs/patterns/code/index.html similarity index 100% rename from public/patterns/code/index.html rename to docs/patterns/code/index.html diff --git a/public/patterns/code/index.xml b/docs/patterns/code/index.xml similarity index 100% rename from public/patterns/code/index.xml rename to docs/patterns/code/index.xml diff --git a/public/patterns/code/writing-inline-demos/index.html b/docs/patterns/code/writing-inline-demos/index.html similarity index 100% rename from public/patterns/code/writing-inline-demos/index.html rename to docs/patterns/code/writing-inline-demos/index.html diff --git a/public/patterns/index.html b/docs/patterns/index.html similarity index 100% rename from public/patterns/index.html rename to docs/patterns/index.html diff --git a/public/patterns/index.xml b/docs/patterns/index.xml similarity index 89% rename from public/patterns/index.xml rename to docs/patterns/index.xml index a0dcaae..2b82be7 100644 --- a/public/patterns/index.xml +++ b/docs/patterns/index.xml @@ -39,8 +39,7 @@ brew install hugo Alternatively, you can manually install Hugo from a package. Y https://heydon.github.io/infusion/patterns/serving/ Serving locally While you’re creating content for your library, you’ll probably want to see what the finished product looks like. Fortunately, Infusion is easy to serve locally using the serve command: -npm run serve This will serve your working library on localhost:1313. Whenever you make changes to your library’s files, the site will automatically rebuild. No need to refresh the web page! -Publishing on Github Pages There are three steps to hosting your library on Github Pages. +npm run serve This will serve your working library from localhost:1313 (the exact URL will be determined by what’s in your baseURL and will be revealed to you by your terminal). Whenever you make changes to your library’s files, the site will automatically rebuild. diff --git a/public/patterns/installation/index.html b/docs/patterns/installation/index.html similarity index 100% rename from public/patterns/installation/index.html rename to docs/patterns/installation/index.html diff --git a/public/patterns/library-setup/index.html b/docs/patterns/library-setup/index.html similarity index 100% rename from public/patterns/library-setup/index.html rename to docs/patterns/library-setup/index.html diff --git a/public/patterns/serving/index.html b/docs/patterns/serving/index.html similarity index 97% rename from public/patterns/serving/index.html rename to docs/patterns/serving/index.html index 33b5470..bfe1885 100644 --- a/public/patterns/serving/index.html +++ b/docs/patterns/serving/index.html @@ -194,7 +194,7 @@ 
npm run serve
-

This will serve your working library on localhost:1313. Whenever you make changes to your library’s files, the site will automatically rebuild. No need to refresh the web page!

+

This will serve your working library from localhost:1313 (the exact URL will be determined by what’s in your baseURL and will be revealed to you by your terminal). Whenever you make changes to your library’s files, the site will automatically rebuild. No need to refresh the web page!

Publishing on Github Pages

diff --git a/public/patterns/writing/expandable-sections/index.html b/docs/patterns/writing/expandable-sections/index.html similarity index 100% rename from public/patterns/writing/expandable-sections/index.html rename to docs/patterns/writing/expandable-sections/index.html diff --git a/public/patterns/writing/including-images/index.html b/docs/patterns/writing/including-images/index.html similarity index 100% rename from public/patterns/writing/including-images/index.html rename to docs/patterns/writing/including-images/index.html diff --git a/public/patterns/writing/index.html b/docs/patterns/writing/index.html similarity index 100% rename from public/patterns/writing/index.html rename to docs/patterns/writing/index.html diff --git a/public/patterns/writing/index.xml b/docs/patterns/writing/index.xml similarity index 100% rename from public/patterns/writing/index.xml rename to docs/patterns/writing/index.xml diff --git a/public/patterns/writing/library-structure/index.html b/docs/patterns/writing/library-structure/index.html similarity index 100% rename from public/patterns/writing/library-structure/index.html rename to docs/patterns/writing/library-structure/index.html diff --git a/public/patterns/writing/markdown-and-metadata/index.html b/docs/patterns/writing/markdown-and-metadata/index.html similarity index 100% rename from public/patterns/writing/markdown-and-metadata/index.html rename to docs/patterns/writing/markdown-and-metadata/index.html diff --git a/public/patterns/writing/notes-and-warnings/index.html b/docs/patterns/writing/notes-and-warnings/index.html similarity index 100% rename from public/patterns/writing/notes-and-warnings/index.html rename to docs/patterns/writing/notes-and-warnings/index.html diff --git a/public/patterns/writing/references/index.html b/docs/patterns/writing/references/index.html similarity index 100% rename from public/patterns/writing/references/index.html rename to docs/patterns/writing/references/index.html diff --git a/public/sitemap.xml b/docs/sitemap.xml similarity index 100% rename from public/sitemap.xml rename to docs/sitemap.xml diff --git a/public/tags/index.xml b/docs/tags/index.xml similarity index 100% rename from public/tags/index.xml rename to docs/tags/index.xml diff --git a/package.json b/package.json index 0266a32..1f5af7c 100644 --- a/package.json +++ b/package.json @@ -8,9 +8,7 @@ "test": "echo \"Error: no test specified\" && exit 1", "serve": "hugo server", "clean": "rm -rf content && mkdir content && mkdir content/patterns && hugo new patterns/pattern.md && hugo new _index.md", - "build": "hugo", - "setup": "hugo && git add public", - "host": "hugo && git push origin `git subtree split --prefix public master`:gh-pages --force" + "build": "hugo" }, "repository": { "type": "git",