Giter VIP home page Giter VIP logo

metalsmith-choo's Introduction

Metalsmith-choo

Travis branch npm

Wiki

You can find a tutorial here

Install

npm install metalsmith-choo

Usage

// In yout metalsmith file

const metalsmith = require('metalsmith')
const markdown = require('metalsmith-markdown')
const choo = require('../lib/')

metalsmith(__dirname)
.source('src')
.destination('dist')
.use(markdown())
.use(choo({
  entry: './choo/index.js'
, routes: ['/', '/about']
, bundle: '/bundle.js'
}))
.build(err => err ? console.error(err) : console.log("builded."))

In your choo app require the wrapper.

  const wrapper = require('metalsmith-choo/lib/chooWrap')

and then replace the app.start() by :

  module.exports = wrapper(app)

Informations

The metalsmith metadata will be automaticly added to your app state under the key 'metadata'. The content of the file from metalsmith will be added to your app state under the key you specified in your frontmatter.

markdown example file:

---
namespace: home
// eventually more key, they will be add to your state
title: Homepage
---

# Hello content

Roadmap

  • handle dynamic routing with metalsmith-collection ?
  • get route from choo app (avoid the user to explicitly tell the routes to render)

Tests

npm run test

Contribute

Make an issue or a PR :) To commit just use npm run commit

metalsmith-choo's People

Contributors

wcastand avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

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.