smithsonian

web interface for Metalsmith

Smithsonian

Smithsonian is a web interface for Metalsmith. If you are already using Metalsmith, adopting Smithsonian could not be easier. Smithsonian extends Metalsmith so the exact same plugin/middleware system works, just swap out Metalsmith for Smithsonian.

Metalsmith = require('metalsmith');
Metalsmith(__dirname)
  .use(markdown())
  .use(templates('handlebars'))
  .build();

..becomes..

Smithsonian = require('smithsonian');
Smithsonian(__dirname)
  .use(markdown())
  .use(templates('handlebars'))
  .build() // still builds as expected 
  .listen(8080); // listening on localhost:8080 

Note: Smithsonian calls build() internally when listen() is called.

The third version of Smithsonian brings huge underlying changes with only minor developer facing changes. The most important change is that Smithsonian's file access API is now completely decoupled from the user interface. This means that a custom interface can be used instead. This eliminates the need for the old configuration options. And although now decoupled, the default user interface Standard has been completely visually overhauled and has a lot more features.

To upgrade from v2 to v3, add the web interface to your Express application, like how the Smithsonian API router is added using express.use(). Note: this is only necessary if Smithsonian is nested inside another application.

npm install smithsonian

Smithsonian can be used as an Express application or as an Express middleware and router inside of an existing Express application. Smithsonian is designed to be completely detached from the rest of the application so there are no side-effects to incorporating Smithsonian into a project.

var Smithsonian = require('smithsonian');
Smithsonian(__dirname).listen(3000);
var express = require('express'),
    Smithsonian = require('smithsonian');
 
express()
    .use('/subdirectory', Smithsonian(__dirname).router())
    .listen(3000);
express()
  .use('/smithsonian', require('smithsonian/standard')(API_URL))
  .listen(3000);
// where API_URL is wherever the Smithsonian router is mounted. 

Smithsonian is really just a basic file explorer that only works with a Metalsmith source directory. It does not serve the built files; use http-server for that. Smithsonian is really useful for remote deploys and as an administration interface. Smithsonian is like an extremely minimal CMS, but for Metalsmith.

Say you have Metalsmith building static content behind Nginx. Expose Smithsonian (preferably backed by forever) in the Nginx config and you now have an easily accessible administration tool to create, edit, and delete source files. No need to build locally and deploy with git or any other manual tool.

Building a simple blog for a company/client? If they can manage plain text, Smithsonian is good enough to hand off to clients.

Smithsonian only exposes the plugin system of Metalsmith, which are only #use() and #build(). All other methods calls outside of Metalsmith plugins will need to use Smithsonian.metalsmith which is Smithsonian's Metalsmith instance.

Smithsonian also exposes #listen() which will start the web server that serves the interface and #router() which returns the Express router middleware.

Smithsonian comes with a default web interface called Standard. If a custom design is needed, Smithsonian is completely decoupled from the underlying API.

Thanks for using Smithsonian. Or for at least reading this far down into the README.

Follow me on Twitter for updates or just for the lolz and please check out my other repositories if I have earned it. I thank you for reading.