Code Monkey home page Code Monkey logo

assemble-scaffold's Introduction

assemble-scaffold

Scaffold for an assemble based web site.

Work in progress: stay tuned

About

Assemble seems to be the most promising static site generator if you prefer to use JavaScript. The entire solution has been completely rewritten in 2015, now (as of 12/2015) the new version 0.6.0 is available.

This project is an attempt to verify if assemble fits my needs to create a bit more complex website based on a static website generator.

The goal of this project is to create a nice scaffold using Assemble which can then be used in multiple projects with very little configuration.

Planned features:

  • Error handling to ensure that everything went well

  • Error notification

  • Basic Setup:

    • Cleaning the build directory
    • Copying site assets
    • Fetching external content (mainly from GitHub pages)
    • Less conversion
    • CSS minification
    • CSS sourcemaps
  • Content Types

    • Pages
    • Article
    • Blog
    • Archive
    • Projects
  • Content Handling

    • Markdown conversion
    • Partials
  • Different:

    • layouts
    • collections
  • Validation:

    • CSS Lint
    • Html Lint
    • Link validation
    • Front matter validation & defaults
  • Optimization

    • Remove unused CSS
    • Uglify JavaScript files
    • Prettifying Html output
  • Dynamic loading of:

    • handlebar templates
    • partials
    • layouts
    • plugins
  • SEO

    • Include excerpt
  • Single page features

    • Conditional table of contents
    • Code formatting
    • Hybrid formatting (.md + .html)
    • Responsive images
  • Site features:

    • Lunr search
    • Tags
    • Permalinks
    • Comments, either linking to GitHub or to Disqus
    • Collections
    • Sitemap
    • Aliases for pages
    • RSS generator
    • Related posts
    • Favicons
  • Api documentation integration

    • Integrate pages with JSDoc/ESDoc output
  • Publishing process

    • Auto versioning
    • Create summary of published results / changes
    • Auto upload to Amazon S3
  • Logging

    • Need good logging to see if everything went well
  • Testing

    • Full test coverage to ensure that everything continues to work

Install

$ npm i assemble-scaffold --save

Configuration

(TBD)

Author

Stefan Walther

License

Released under the MIT license.


assemble-scaffold's People

Contributors

stefanwalther avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

assemble-scaffold's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

assemble plugins

This is great. I'm doing something similar for assemble and verb as soon as the CLI is done (not the same, but we'll move some defaults into an external project to make it easier to unit test and create issues for that).

Suggestion: Instead of creating classes, it would probably be a better pattern to use Assemble's API to accomplish what you need. Since we don't have docs for the things you can use for this yet, I'll add some suggestions below.

Assemble's API has static and prototype methods for using plugins, either of which could accomplish what you're doing there in a more composable way - and using assemble's API, so it would be friendlier to other assemble users or for you when you work on other projects.

Example

function defaultConfig(options) {
  return function(app) {

    /**
     * Customize how templates are stored. This changes the
     * key of each template, so it's easier to lookup later
     */

    app.option('renameKey', function (fp) {
      return path.basename(fp, path.extname(fp));
    });

    app.preLayout(/\/content\/.*\.md/, function (view, next) {
      // don't add the default layout to partials, and account for 
      // templates that might define `null` to exclude the layout
      if (!view.isType('partial') && typeof view.layout === 'undefined') {
        view.layout = 'default';
      }
      next();
    });
  };
};

/**
 * A few options for using the plugin
 */

// "global" plugin - called in the constructor upon instantiation
// (in the plugin, `app` is the assemble **instance**). Although this 
// is really just an instance plugin, like the next example, these plugins
// will be called before other instance plugins, and on every instance created
assemble.use(defaultConfig());

// instance plugin - if you want to ensure that plugins are called immediately _after_ 
// instantiation, then use it as an instance plugin
// (in the plugin, `app` is the assemble **instance**)
var app = assemble();
app.use(defaultConfig());

// `mixin` - in rare cases, if you absolutely must modify the prototype, you
// can register the plugin as a `mixin`
// (in the plugin, `app` is the assemble **prototype**)
assemble.mixin(defaultConfig());

/**
 * You can wrap plugins too if you want
 */

function assembleScaffold(config) {
  return function(app) {
    this.origConfig = config;

    // plugins
    this.use(defaultConfig());
    this.use(foo());
    this.use(bar());
    this.use(baz());
  };
}

/**
 * And use them all together like this
 */

var assemble = require('assemble');

var app = assemble()
  .use(assembleScaffold());

Hope this helps.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Once you have installed CI on this repository, you’ll need to re-trigger Greenkeeper’s initial Pull Request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.