Code Monkey home page Code Monkey logo

mbox-to-tiddlers's Introduction

mbox-to-tiddlers

A utility to convert mbox files into tiddlers

Overview

Each message in the mbox file is converted into a separate tiddler with the following fields:

  • title: message ID
  • caption: message subject
  • from: message sender
  • text: message text
  • type: text/plain
  • modified: message date (in TiddlyWiki format)

Installation

Prerequisites: Node.js

  1. Download or clone this repository
  2. Open a command prompt in the root of the repository
  3. Execute npm install to install dependencies

Usage

Invoke the converter with a filepath to the mbox file and the path where the output tiddler files should be saved:

node ./index.js path/to/mbox/file ./wiki/tiddlers/converted

(The resulting tiddlers in ./wiki/tiddlers/converted should be deleted before converting a diffferent mbox file).

You can then build the resulting tiddlers into a functioning TiddlyWiki with:

node ./node_modules/tiddlywiki/tiddlywiki.js ./wiki --build index

The output file will be found at ./wiki/output/index.html.

Acknowledgements

This utility is based on these two awesome projects:

mbox-to-tiddlers's People

Contributors

jermolene avatar

Watchers

 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.