From c8e46b9955cd39018e556724cf87930865d03c1f Mon Sep 17 00:00:00 2001 From: readme Date: Tue, 3 Mar 2020 11:38:04 +0100 Subject: [PATCH] update github abs path --- README.md | 6 ++++++ build.js | 2 +- build/article/draft/index.html | 2 +- build/article/future/index.html | 2 +- build/article/gotchas/index.html | 2 +- build/article/gulp/index.html | 4 ++-- build/article/index.html | 2 +- build/article/usage/index.html | 2 +- build/contact/index.html | 2 +- build/index.html | 2 +- build/sitemap.xml | 28 ++++++++++++------------- build/start/build/index.html | 2 +- build/start/index.html | 2 +- build/start/installation/index.html | 2 +- build/start/page-definitions/index.html | 4 ++-- build/start/plugins/index.html | 2 +- build/start/site-files/index.html | 2 +- 17 files changed, 37 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index b2715a7..a61e29a 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,12 @@ To build the site for production and compress HTML files: npm run production ``` +on windows command line (not powershell, not vscode terminal): + +```bash +npm run production-win +``` + The site is built in the `/build` folder. ## Further information diff --git a/build.js b/build.js index 094ac83..6f86aa5 100644 --- a/build.js +++ b/build.js @@ -21,7 +21,7 @@ siteMeta = { author: 'dashdevs', contact: 'https://chat.dashdevs.org', domain: devBuild ? 'http://127.0.0.1' : 'https://rawgit.com', // set domain - rootpath: devBuild ? null : '/dashdev-suite/dashdev-website/master/build/' // set absolute path (null for relative) + rootpath: devBuild ? null : '/dashdev-website/build/' // set absolute path (null for relative) }; templateConfig = { diff --git a/build/article/draft/index.html b/build/article/draft/index.html index 653d9eb..638a615 100644 --- a/build/article/draft/index.html +++ b/build/article/draft/index.html @@ -1 +1 @@ -Draft article - dashdev-website

Draft article

Published 26 February 2020, 26 words, 1-minute read

This is a draft article.

It will never appear in the site unless the publish front-matter is set to published or a date which has passed.

\ No newline at end of file +Draft article - dashdev-website

Draft article

Published 26 February 2020, 26 words, 1-minute read

This is a draft article.

It will never appear in the site unless the publish front-matter is set to published or a date which has passed.

\ No newline at end of file diff --git a/build/article/future/index.html b/build/article/future/index.html index 496a5b2..65f1cfd 100644 --- a/build/article/future/index.html +++ b/build/article/future/index.html @@ -1 +1 @@ -Future publication - dashdev-website

Future publication

Published 1 March 2016, 16 words, 1-minute read

This article will only appear if the site is built is run after 1 March, 2016.

\ No newline at end of file +Future publication - dashdev-website

Future publication

Published 1 March 2016, 16 words, 1-minute read

This article will only appear if the site is built is run after 1 March, 2016.

\ No newline at end of file diff --git a/build/article/gotchas/index.html b/build/article/gotchas/index.html index 2490b16..cc1f097 100644 --- a/build/article/gotchas/index.html +++ b/build/article/gotchas/index.html @@ -1 +1 @@ -Gotchas - dashdev-website

Gotchas

Published 10 March 2016, 127 words, 1-minute read

Not everything is necessarily straight-forward in the Metalsmith world…

Incompatible plugins

Some plugins clash with another. For example, metalsmith-rootpath which calculates relative roots does not play nicely with metalsmith-permalinks which creates custom folder structures.

Note: lib/metalsmith-moremeta in this project sets a correct root variable whether permalinks are used or not.

Plugin order can be critical

One plugins may depend on another or conflict if placed the wrong way around. For example, the RSS-generating metalsmith-feed plugin must be called after metalsmith-layouts to ensure rss.xml is not generated within a page template.

Browsersync build issues

When Browsersync is running and files are edited, collections are re-parsed but the old data remains. This can cause menus and next/back links to be incorrect. To fix this, stop and restart the build.

\ No newline at end of file +Gotchas - dashdev-website

Gotchas

Published 10 March 2016, 127 words, 1-minute read

Not everything is necessarily straight-forward in the Metalsmith world…

Incompatible plugins

Some plugins clash with another. For example, metalsmith-rootpath which calculates relative roots does not play nicely with metalsmith-permalinks which creates custom folder structures.

Note: lib/metalsmith-moremeta in this project sets a correct root variable whether permalinks are used or not.

Plugin order can be critical

One plugins may depend on another or conflict if placed the wrong way around. For example, the RSS-generating metalsmith-feed plugin must be called after metalsmith-layouts to ensure rss.xml is not generated within a page template.

Browsersync build issues

When Browsersync is running and files are edited, collections are re-parsed but the old data remains. This can cause menus and next/back links to be incorrect. To fix this, stop and restart the build.

\ No newline at end of file diff --git a/build/article/gulp/index.html b/build/article/gulp/index.html index df19709..3c93989 100644 --- a/build/article/gulp/index.html +++ b/build/article/gulp/index.html @@ -1,4 +1,4 @@ -Gulp - dashdev-website

Gulp

Published 2 March 2016, 141 words, 1-minute read

Metalsmith has plugins for CSS pre-processing with Sass, image minification, file concatenation, uglification and more. The build code will be familiar to anyone with Gulp experience.

Do you still need Gulp?

Metalsmith is often enough for simpler workflows. However, Gulp has a more extensive range of plugins and permits complex build activities such as linting and PostCSS processing with auto-prefixer.

Metalsmith can be used within any Gulp task, e.g.

var
+Gulp - dashdev-website
Gulp
Published 2 March 2016, 141 words, 1-minute read
Metalsmith has plugins for CSS pre-processing with Sass, image minification, file concatenation, uglification and more. The build code will be familiar to anyone with Gulp experience.
Do you still need Gulp?
Metalsmith is often enough for simpler workflows. However, Gulp has a more extensive range of plugins and permits complex build activities such as linting and PostCSS processing with auto-prefixer.
Metalsmith can be used within any Gulp task, e.g.
var
     gulp       = require('gulp'),
     metalsmith = require('metalsmith'),
     publish    = require('metalsmith-publish'),
@@ -17,4 +17,4 @@ gulp.task('html', function() {
             if (err) throw err;
         });
 
-});
Further Gulp tasks can then be added. Note .clean(false) ensures Metalsmith never wipes the build folder when other tasks are active.
There are a number of Gulp/Metalsmith integration plugins although they are rarely necessary.

\ No newline at end of file
+});

Further Gulp tasks can then be added. Note .clean(false) ensures Metalsmith never wipes the build folder when other tasks are active.

There are a number of Gulp/Metalsmith integration plugins although they are rarely necessary.

\ No newline at end of file diff --git a/build/article/index.html b/build/article/index.html index 6e69407..6325213 100644 --- a/build/article/index.html +++ b/build/article/index.html @@ -1 +1 @@ -Articles - dashdev-website
\ No newline at end of file +Articles - dashdev-website
\ No newline at end of file diff --git a/build/article/usage/index.html b/build/article/usage/index.html index af1315c..0d14d84 100644 --- a/build/article/usage/index.html +++ b/build/article/usage/index.html @@ -1 +1 @@ -Usage options - dashdev-website

Usage options

Published 14 March 2016, 47 words, 1-minute read

Metalsmith could be used to create any number of resources, including:

  • a fast static website with minimal server-side requirements
  • technical documentation
  • an eBook
  • application prototypes
  • build tools or project scaffolding

The markdown files can be converted to other files types using plugins such as metalsmith-pandoc or metalsmith-pdf.

\ No newline at end of file +Usage options - dashdev-website

Usage options

Published 14 March 2016, 47 words, 1-minute read

Metalsmith could be used to create any number of resources, including:

  • a fast static website with minimal server-side requirements
  • technical documentation
  • an eBook
  • application prototypes
  • build tools or project scaffolding

The markdown files can be converted to other files types using plugins such as metalsmith-pandoc or metalsmith-pdf.

\ No newline at end of file diff --git a/build/contact/index.html b/build/contact/index.html index 4dc9171..2baf08c 100644 --- a/build/contact/index.html +++ b/build/contact/index.html @@ -1 +1 @@ -Contact - dashdev-website
\ No newline at end of file +Contact - dashdev-website
\ No newline at end of file diff --git a/build/index.html b/build/index.html index c3fedea..231ed8a 100644 --- a/build/index.html +++ b/build/index.html @@ -1 +1 @@ -dashdev-website

Node.js

This is a static website generated using the Node.js-powered Metalsmith and various published and custom plugins.

This is a demonstration rather than a recommended way to build a static site. Your requirements will be different. Please use any part of the code as you wish.

Where could you use Metalsmith?

Metalsmith could be used to create:

  • a fast static website with minimal server-side requirements
  • technical documentation
  • an eBook
  • application prototypes
  • build tools or project scaffolding

Get started…

\ No newline at end of file +dashdev-website

Node.js

This is a static website generated using the Node.js-powered Metalsmith and various published and custom plugins.

This is a demonstration rather than a recommended way to build a static site. Your requirements will be different. Please use any part of the code as you wish.

Where could you use Metalsmith?

Metalsmith could be used to create:

  • a fast static website with minimal server-side requirements
  • technical documentation
  • an eBook
  • application prototypes
  • build tools or project scaffolding

Get started…

\ No newline at end of file diff --git a/build/sitemap.xml b/build/sitemap.xml index 980521e..5928fcf 100644 --- a/build/sitemap.xml +++ b/build/sitemap.xml @@ -1,17 +1,17 @@ - https://rawgit.com/dashdev-suite/dashdev-website/master/build/ 1.0 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/article/draft/ - https://rawgit.com/dashdev-suite/dashdev-website/master/build/article/future/ - https://rawgit.com/dashdev-suite/dashdev-website/master/build/article/gotchas/ - https://rawgit.com/dashdev-suite/dashdev-website/master/build/article/gulp/ - https://rawgit.com/dashdev-suite/dashdev-website/master/build/article/ 0.8 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/article/usage/ - https://rawgit.com/dashdev-suite/dashdev-website/master/build/contact/ 0.7 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/start/build/ 0.5 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/start/ 0.9 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/start/installation/ 0.5 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/start/page-definitions/ 0.3 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/start/plugins/ 0.3 - https://rawgit.com/dashdev-suite/dashdev-website/master/build/start/site-files/ 0.4 + https://rawgit.com/dashdev-website/build/ 1.0 + https://rawgit.com/dashdev-website/build/article/future/ + https://rawgit.com/dashdev-website/build/article/draft/ + https://rawgit.com/dashdev-website/build/article/gotchas/ + https://rawgit.com/dashdev-website/build/article/gulp/ + https://rawgit.com/dashdev-website/build/article/ 0.8 + https://rawgit.com/dashdev-website/build/article/usage/ + https://rawgit.com/dashdev-website/build/contact/ 0.7 + https://rawgit.com/dashdev-website/build/start/build/ 0.5 + https://rawgit.com/dashdev-website/build/start/installation/ 0.5 + https://rawgit.com/dashdev-website/build/start/ 0.9 + https://rawgit.com/dashdev-website/build/start/page-definitions/ 0.3 + https://rawgit.com/dashdev-website/build/start/plugins/ 0.3 + https://rawgit.com/dashdev-website/build/start/site-files/ 0.4 \ No newline at end of file diff --git a/build/start/build/index.html b/build/start/build/index.html index 085e2b4..93d799b 100644 --- a/build/start/build/index.html +++ b/build/start/build/index.html @@ -1 +1 @@ -Build - dashdev-website

Build

Published 26 February 2020, 55 words, 1-minute read

To build and launch the site in a test server using Browsersync:

npm start

(Stop the server with Ctrl+C.)

To build the site for production and compress HTML files:

npm run production

The site is built in the /build folder.

Note you may want to change the siteMeta.domain and siteMeta.rootpath on lines 52 and 53 of ./build.js.

\ No newline at end of file +Build - dashdev-website

Build

Published 26 February 2020, 55 words, 1-minute read

To build and launch the site in a test server using Browsersync:

npm start

(Stop the server with Ctrl+C.)

To build the site for production and compress HTML files:

npm run production

The site is built in the /build folder.

Note you may want to change the siteMeta.domain and siteMeta.rootpath on lines 52 and 53 of ./build.js.

\ No newline at end of file diff --git a/build/start/index.html b/build/start/index.html index 648f39f..e084c1b 100644 --- a/build/start/index.html +++ b/build/start/index.html @@ -1 +1 @@ -Start - dashdev-website
\ No newline at end of file +Start - dashdev-website
\ No newline at end of file diff --git a/build/start/installation/index.html b/build/start/installation/index.html index b97afae..06632f8 100644 --- a/build/start/installation/index.html +++ b/build/start/installation/index.html @@ -1 +1 @@ -Installation - dashdev-website

Installation

Published 2 March 2020, 27 words, 1-minute read

Please ensure Node.js and Git are installed on your system.

Download the demonstration code and switch to directory:

git clone git@github.com:dashdev-suite/dashdev-website.git cd metalsmith-demo

Install dependencies:

npm install
\ No newline at end of file +Installation - dashdev-website

Installation

Published 2 March 2020, 27 words, 1-minute read

Please ensure Node.js and Git are installed on your system.

Download the demonstration code and switch to directory:

git clone git@github.com:dashdev-suite/dashdev-website.git cd metalsmith-demo

Install dependencies:

npm install
\ No newline at end of file diff --git a/build/start/page-definitions/index.html b/build/start/page-definitions/index.html index a001df7..8afce96 100644 --- a/build/start/page-definitions/index.html +++ b/build/start/page-definitions/index.html @@ -1,8 +1,8 @@ -Page definitions - dashdev-website

Page definitions

Published 26 February 2020, 194 words, 1-minute read

Each sub-folder in src/html is a website section. Pages named index.md are the default page in section. File paths are translated to permalinks, e.g.

src/html/article/mypage.md

is rendered to:

build/article/mypage/index.html

Pages use YAML front-matter defined at the top. This can be referenced in templates or during the build process, e.g.

---
+Page definitions - dashdev-website
Page definitions
Published 26 February 2020, 194 words, 1-minute read
Each sub-folder in src/html is a website section. Pages named index.md are the default page in section. File paths are translated to permalinks, e.g.
src/html/article/mypage.md
is rendered to:
build/article/mypage/index.html
Pages use YAML front-matter defined at the top. This can be referenced in templates or during the build process, e.g.
---
 title: My page title
 description: A description of this page for meta tags and page lists.
 layout: page.html
 priority: 0.9
 publish: 2016-06-01
 date: 2016-06-01
----
All items are optional. Note:
  • layout defaults to page.html unless metadata.layout is defined for the page collection (see the use(collections({ ... }) code in build.js).
  • priority is a number between 0 (low) and 1 (high) which is used to order menus and define XML sitemaps.
  • publish can be set draft, private or a future date to ensure it is not published until required.
  • date is the date of the article. If not set, a future publish date or the file creation date is used.
The page content is defined in markdown, HTML syntax or both below the front-matter section. The content can include Handlebars partials from the src/partials folder, e.g.
{{> partialname }}
where partialname is the partial filename without its .html extension.

\ No newline at end of file
+---

All items are optional. Note:

  • layout defaults to page.html unless metadata.layout is defined for the page collection (see the use(collections({ ... }) code in build.js).
  • priority is a number between 0 (low) and 1 (high) which is used to order menus and define XML sitemaps.
  • publish can be set draft, private or a future date to ensure it is not published until required.
  • date is the date of the article. If not set, a future publish date or the file creation date is used.

The page content is defined in markdown, HTML syntax or both below the front-matter section. The content can include Handlebars partials from the src/partials folder, e.g.

{{> partialname }}

where partialname is the partial filename without its .html extension.

\ No newline at end of file diff --git a/build/start/plugins/index.html b/build/start/plugins/index.html index fdbd23f..89fa054 100644 --- a/build/start/plugins/index.html +++ b/build/start/plugins/index.html @@ -1 +1 @@ -Custom plugins - dashdev-website

Custom plugins

Published 2 March 2020, 77 words, 1-minute read

The build.js file defines how the site is built using Metalsmith and various plugins.

Several custom plugins have been created specifically for this site:

  • lib/metalsmith-debug.js: output debugging information to the console.
  • lib/metalsmith-setdate.js: ensure each page has a date. If a date is not defined in the page's front-matter, it is presumed to be the publish or file creation date.
  • lib/metalsmith-moremeta.js: applies further metadata to each page including the root folder, a default layout, primary and secondary navigation.
\ No newline at end of file +Custom plugins - dashdev-website

Custom plugins

Published 2 March 2020, 77 words, 1-minute read

The build.js file defines how the site is built using Metalsmith and various plugins.

Several custom plugins have been created specifically for this site:

  • lib/metalsmith-debug.js: output debugging information to the console.
  • lib/metalsmith-setdate.js: ensure each page has a date. If a date is not defined in the page's front-matter, it is presumed to be the publish or file creation date.
  • lib/metalsmith-moremeta.js: applies further metadata to each page including the root folder, a default layout, primary and secondary navigation.
\ No newline at end of file diff --git a/build/start/site-files/index.html b/build/start/site-files/index.html index 7b3bc37..d4771d8 100644 --- a/build/start/site-files/index.html +++ b/build/start/site-files/index.html @@ -1 +1 @@ -Site files - dashdev-website

Site files

Published 26 February 2020, 57 words, 1-minute read

All files in the src folder can be edited:

  • pages are created as markdown files in the src/html folder and sub-folders.
  • static assets such as CSS, JavaScript and image files are created in src/assets. These are copied without modification to build/.
  • page templates are defined in src/template.
  • reusable partials (chunks of HTML code) are declared in src/partials.
\ No newline at end of file +Site files - dashdev-website

Site files

Published 26 February 2020, 57 words, 1-minute read

All files in the src folder can be edited:

  • pages are created as markdown files in the src/html folder and sub-folders.
  • static assets such as CSS, JavaScript and image files are created in src/assets. These are copied without modification to build/.
  • page templates are defined in src/template.
  • reusable partials (chunks of HTML code) are declared in src/partials.
\ No newline at end of file