Code Monkey home page Code Monkey logo

mdt's Introduction

MDTracker (Markdown Tracker)

What It Does

MDTracker (Markdown Tracker) provide a solution for writers using Markdown. You can calculate various statistics based on the document structure. For instance, how long each of your sections and subsections are. Since a writing project is organized by document structure, this is much more useful than just counting words for whole document.

You can also compare two versions of your document at section-level. Note that this is immensely more useful than line-by-line diff, because the tool is aware of Markdown syntax. For instance, the difference is summarized at section-level, and all the comments are ignored.

Better yet, MDTracker can help you track the progress of your writing real-time. Just turn on the monitoring function of the tool, and then it will automatically track the difference at the time interval you specified. Again, the tracking is aware of the document structure, so that you can track what progress you made in different parts of your document.

Applications

Tracking for a Writing Project

Out of the box, MDTracker supports various basic statistics of the document at component-level. This includes basic character, word and sentence-level counting. Use MDTracker to track your writing projects.

Tracking for Journals

If you use Markdown to write a journal, you can use MDTracker to track various activities you do throughout the day. Since MDTracker tracks every change of your document, you can track when you created and finished a task, what happened at which time of the day, and so on.

Installation

MDTracker requires a python installation with data science toolkits, including numpy and pandas. I recommend Anaconda Python distribution for Windows.

Once you set up the environment, you can clone this repository, and then add the folder to PYTHONPATH so that you can invoke the tool from anywhere.

Basic Usage

Commands and Options

Document Statistics

mdt parse mdt_demo.md

Document Diff(erence)

mdt parse mdt_demo.md mdt_demo_new.md

Document Monitoring

mdt monitor mdt_demo.md

mdt's People

Contributors

jykim avatar

Stargazers

Rohit Rathi 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.