Permalink
Browse files

use eyeglass-dev-site-builder, add new site structure

  • Loading branch information...
eoneill committed Nov 25, 2015
1 parent b391206 commit 2485e461410f650b8be368c956f13a38ba4486c8
Showing with 596 additions and 26 deletions.
  1. +2 −1 .gitignore
  2. +37 −0 CONTRIBUTING.md
  3. +41 −0 build/.linkchecker.cache
  4. +58 −0 build/site.js
  5. +5 −2 gulpfile.js
  6. +0 −16 metalsmith.json
  7. +6 −7 package.json
  8. +1 −0 site-src/README.md
  9. +10 −0 site/content/documentation/assets.md
  10. +10 −0 site/content/documentation/authoring-eyeglass-module.md
  11. +11 −0 site/content/documentation/common-and-known-issues.md
  12. +10 −0 site/content/documentation/debugging.md
  13. +10 −0 site/content/documentation/errors-and-warnings.md
  14. +10 −0 site/content/documentation/eyeglass-module.md
  15. +10 −0 site/content/documentation/getting-started.md
  16. +10 −0 site/content/documentation/how-eyeglass-works.md
  17. +10 −0 site/content/documentation/installing-eyeglass-module.md
  18. +11 −0 site/content/documentation/integrating-with-broccoli.md
  19. +11 −0 site/content/documentation/integrating-with-ember.md
  20. +11 −0 site/content/documentation/integrating-with-grunt.md
  21. +11 −0 site/content/documentation/integrating-with-gulp.md
  22. +11 −0 site/content/documentation/integrating-with-node-sass.md
  23. +10 −0 site/content/documentation/options.md
  24. +10 −0 site/content/documentation/why-eyeglass.md
  25. +14 −0 site/index.html
  26. +2 −0 site/layouts/browserconfig.hbt
  27. +24 −0 site/layouts/default.hbt
  28. +23 −0 site/layouts/feed.hbt
  29. +16 −0 site/layouts/landing.hbt
  30. +15 −0 site/layouts/sitemap.hbt
  31. +40 −0 site/layouts/topic.hbt
  32. +28 −0 site/layouts/topics.hbt
  33. +1 −0 site/root/CNAME
  34. BIN site/root/android-icon-144x144.png
  35. BIN site/root/android-icon-192x192.png
  36. BIN site/root/android-icon-36x36.png
  37. BIN site/root/android-icon-48x48.png
  38. BIN site/root/android-icon-72x72.png
  39. BIN site/root/android-icon-96x96.png
  40. BIN site/root/apple-icon-114x114.png
  41. BIN site/root/apple-icon-120x120.png
  42. BIN site/root/apple-icon-144x144.png
  43. BIN site/root/apple-icon-152x152.png
  44. BIN site/root/apple-icon-180x180.png
  45. BIN site/root/apple-icon-57x57.png
  46. BIN site/root/apple-icon-60x60.png
  47. BIN site/root/apple-icon-72x72.png
  48. BIN site/root/apple-icon-76x76.png
  49. BIN site/root/apple-icon-precomposed.png
  50. BIN site/root/apple-icon.png
  51. +3 −0 site/root/browserconfig.xml
  52. BIN site/root/favicon-16x16.png
  53. BIN site/root/favicon-32x32.png
  54. BIN site/root/favicon-96x96.png
  55. BIN site/root/favicon.ico
  56. +3 −0 site/root/feed.xml
  57. +41 −0 site/root/manifest.json
  58. BIN site/root/ms-icon-144x144.png
  59. BIN site/root/ms-icon-150x150.png
  60. BIN site/root/ms-icon-310x310.png
  61. BIN site/root/ms-icon-70x70.png
  62. +3 −0 site/root/sitemap.xml
  63. +23 −0 site/scripts/default.js
  64. +13 −0 site/styles/_baseline.scss
  65. +23 −0 site/styles/_layout.scss
  66. +2 −0 site/styles/default.scss
  67. +6 −0 site/topics/index.html
View
@@ -29,4 +29,5 @@ build/Release
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
/node_modules
/coverage
/site
/tmp
View
@@ -0,0 +1,37 @@
Thanks for contributing! Check back here for more info to come.
# Website
The documentation, site content, and styles can be found in `./site/`
## Building
```sh
gulp site
```
## Deploying locally
```sh
gulp site:dev
```
### Staging
To test against a more prod-like environment (e.g. minified, etc), use `gulp site:staging` to deploy the staging server locally.
## Deploying to production
```sh
gulp site:deploy
```
### Dry run
To do a dry run before deploying to production, run `gulp site:deploy;dry`
## `eyeglass-dev-site-builder`
While the content is here in the main repo, the metalsmith site builder is actually in a separate project. This project is responsible for the actual build interface and is consumed as a dependency.
If you need to make changes beyond what's exposed via the config interface, you'll want to look at [`eyeglass-dev-site-builder`](https://github.com/sass-eyeglass/eyeglass-dev-site-builder).
View
@@ -0,0 +1,41 @@
{
"http://sass-lang.com/": {
"status": 200
},
"https://travis-ci.org/sass-eyeglass/eyeglass": {
"status": 200
},
"https://github.com/sass-eyeglass/eyeglass/blob/master/LICENSE": {
"status": 200
},
"https://github.com/sass-eyeglass/eyeglass/issues": {
"status": 200
},
"https://www.npmjs.com/package/eyeglass": {
"status": 200
},
"https://github.com/sass-eyeglass/eyeglass/": {
"status": 200
},
"http://img.shields.io/npm/l/eyeglass.svg?style=flat-square": {
"status": 200
},
"http://img.shields.io/travis/sass-eyeglass/eyeglass.svg?style=flat-square": {
"status": 200
},
"http://img.shields.io/npm/v/eyeglass.svg?style=flat-square": {
"status": 200
},
"https://github.com/sass-eyeglass/eyeglass": {
"status": 200
},
"http://img.shields.io/github/issues-raw/sass-eyeglass/eyeglass.svg?style=flat-square": {
"status": 200
},
"http://img.shields.io/github/stars/sass-eyeglass/eyeglass.svg?style=flat-square": {
"status": 200
},
"http://img.shields.io/github/forks/sass-eyeglass/eyeglass.svg?style=flat-square": {
"status": 200
}
}
View
@@ -0,0 +1,58 @@
"use strict";
var SiteBuilder = require("eyeglass-dev-site-builder");
var ghPages = require("gulp-gh-pages");
var merge = require("lodash.merge");
var fs = require("fs-extra");
module.exports = function(gulp, depends, root) {
var site = new SiteBuilder({
root: root,
source: "site",
engines: {
Handlebars: require("handlebars")
},
linkchecker: true
});
gulp.task("site", depends, function() {
return site.build({
environment: "production"
});
});
gulp.task("site:dev", depends, function() {
return site.serve();
});
gulp.task("site:staging", depends, function() {
return site.serve({
environment: "staging"
});
});
function createDeployTask(name, options) {
options = merge({
cacheDir: "./tmp/.ghpages"
}, options);
gulp.task("site:" + name, depends, function() {
if (options.clean && options.cacheDir) {
fs.removeSync(options.cacheDir);
}
return gulp.src(site.config.dest + "/**/*")
.pipe(ghPages(options));
});
}
createDeployTask("deploy", {
push: true,
clean: true
});
createDeployTask("deploy:dry", {
push: false
});
};
View
@@ -3,8 +3,11 @@ var gulp = require("gulp");
// Know the node-sass we wrap. It's vital to debugging, tests, and coverage reports
console.log(require("node-sass").info);
require("./build/lint")(gulp, []);
var path = require("path");
require("./build/lint")(gulp);
require("./build/test")(gulp, ["lint"]);
require("./build/coverage")(gulp, []);
require("./build/coverage")(gulp);
require("./build/site")(gulp, null, __dirname);
gulp.task("default", ["test"]);
View

This file was deleted.

Oops, something went wrong.
View
@@ -13,8 +13,7 @@
"main": "lib/index.js",
"README": "README.md",
"scripts": {
"test": "./test.sh",
"site": "./node_modules/.bin/metalsmith"
"test": "./test.sh"
},
"repository": {
"type": "git",
@@ -45,17 +44,17 @@
"devDependencies": {
"eslint": "^1.7.1",
"eyeglass-dev-eslint": "^2.0.0",
"eyeglass-dev-site-builder": "0.0.5",
"fs-extra": "^0.24.0",
"grunt": "^0.4.5",
"grunt-release": "^0.13.0",
"gulp": "^3.9.0",
"gulp-eslint": "^1.0.0",
"gulp-gh-pages": "^0.5.4",
"gulp-istanbul": "^0.10.1",
"gulp-mocha": "^2.1.3",
"handlebars": "^4.0.5",
"mocha": "^2.3.3",
"should": "^7.1.0",
"metalsmith": "^2.1.0",
"metalsmith-layouts": "^1.4.2",
"metalsmith-markdown": "^0.2.1",
"swig": "^1.4.2"
"should": "^7.1.0"
}
}
View
@@ -0,0 +1 @@
These docs will soon be migrated to `site/content/documentation`.
@@ -0,0 +1,10 @@
---
title: Assets
topic: Assets
tags: assets
layout: default.hbt
date: 2015-11-30
order: 2010
---
TODO
@@ -0,0 +1,10 @@
---
title: Authoring an Eyeglass module
topic: Eyeglass Modules
tags: modules, authoring
layout: default.hbt
date: 2015-11-30
order: 1020
---
TODO
@@ -0,0 +1,11 @@
---
title: Common and known issues
shorttitle: Common issues
topic: Troubleshooting
tags: issues
layout: default.hbt
date: 2015-11-30
order: 4040
---
TODO
@@ -0,0 +1,10 @@
---
title: Debugging
topic: Troubleshooting
tags: debug, debugging
layout: default.hbt
date: 2015-11-30
order: 4020
---
TODO
@@ -0,0 +1,10 @@
---
title: Errors and warnings
topic: Troubleshooting
tags: errors, warnings
layout: default.hbt
date: 2015-11-30
order: 4010
---
TODO
@@ -0,0 +1,10 @@
---
title: What is an Eyeglass module
topic: Eyeglass Modules
tags: modules
layout: default.hbt
date: 2015-11-30
order: 1010
---
TODO
@@ -0,0 +1,10 @@
---
title: Getting Started
topic: Getting Started
tags: getting started, installation
layout: default.hbt
date: 2015-11-30
order: 10
---
TODO
@@ -0,0 +1,10 @@
---
title: How Eyeglass works
topic: Getting Started
tags: getting started
layout: default.hbt
date: 2015-11-30
order: 40
---
TODO
@@ -0,0 +1,10 @@
---
title: Installing an Eyeglass module
topic: Eyeglass Modules
tags: modules, installation
layout: default.hbt
date: 2015-11-30
order: 1030
---
TODO
@@ -0,0 +1,11 @@
---
title: Integrating with Broccoli.js
shorttitle: With Broccoli.js
topic: Integration
tags: integration, broccoli
layout: default.hbt
date: 2015-11-30
order: 3020
---
TODO
@@ -0,0 +1,11 @@
---
title: Integrating with Ember CLI
shorttitle: With Ember CLI
topic: Integration
tags: integration, ember, ember-cli
layout: default.hbt
date: 2015-11-30
order: 3060
---
TODO
@@ -0,0 +1,11 @@
---
title: Integrating with Grunt
shorttitle: With Grunt
topic: Integration
tags: integration, grunt
layout: default.hbt
date: 2015-11-30
order: 3040
---
TODO
@@ -0,0 +1,11 @@
---
title: Integrating with gulp.js
shorttitle: With gulp.js
topic: Integration
tags: integration, gulp
layout: default.hbt
date: 2015-11-30
order: 3030
---
TODO
@@ -0,0 +1,11 @@
---
title: Integrating with node-sass
shorttitle: With node-sass
topic: Integration
tags: integration, node-sass
layout: default.hbt
date: 2015-11-30
order: 3010
---
TODO
@@ -0,0 +1,10 @@
---
title: Options
topic: Getting Started
tags: getting started, options, configuration
layout: default.hbt
date: 2015-11-30
order: 30
---
TODO
@@ -0,0 +1,10 @@
---
title: Why Eyeglass
topic: Getting Started
tags: getting started
layout: default.hbt
date: 2015-11-30
order: 50
---
TODO
Oops, something went wrong.

0 comments on commit 2485e46

Please sign in to comment.