https://github.com/lukekarrys/metalsmith-dayone-example

An example Metalsmith site built from Day One data.
https://github.com/lukekarrys/metalsmith-dayone-example

Last synced: 21 days ago
JSON representation

An example Metalsmith site built from Day One data.

• Host: GitHub
• URL: https://github.com/lukekarrys/metalsmith-dayone-example
• Owner: lukekarrys
• License: mit
• Created: 2016-12-05T17:34:11.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-14T01:03:22.000Z (over 3 years ago)
• Last Synced: 2025-01-02T23:49:42.891Z (23 days ago)
• Language: HTML
• Homepage: https://metalsmith-dayone.lukecod.es
• Size: 2.02 MB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - lukekarrys/metalsmith-dayone-example - An example Metalsmith site built from Day One data. (HTML)

README

        
# metalsmith-dayone-example

An example Metalsmith site built from Day One data.

## Demo

You can check out the [deployed version](https://metalsmith-dayone.lukecod.es).

## Features

- Paginated entries pages

- Paginated entries by tag pages

- Tags list page

- Custom domain

- Deploy to GitHub pages

- `pug` template layouts

## Usage

This is mostly a collection of Metalsmith plugins that produces a site with all the features I'd want to publish a [Day One](http://dayoneapp.com/) journal as a blog. I tried to comment everything that's going on in the [`index.js`](./index.js) file, so it'd be at least semi-understandable.

This is just an example, so there's no way to use it directly in your Metalsmith site, but all the Day One data parsing is in the plugin [`metalsmith-dayone`](https://github.com/lukekarrys/metalsmith-dayone) if you wanted to do your own thing with the data.

### Use your own data

It is possible to have this example use your own Day One data, if you wanted to see how that would look:

```sh

# Export your own Day One data as JSON to your-dayone.zip

git clone [email protected]:lukekarrys/metalsmith-dayone-example.git

cd metalsmith-dayone-example

npm install

npm run build -- --data your-dayone.zip 

npm run preview

```

## LICENSE

MIT