Code Monkey home page Code Monkey logo

mukette's Introduction

Mukette: A Pager for Markdown, for UNIX-based Systems

A 'pager' is a utility that takes a markup text (say, Roff) and displays that text, formatted, in the terminal. The first pager was nroff(1) for the aforementioned Roff, and you may still find nroff(1) on UNIX-based systems.

Mukette follows the same template. You pass it one, or several Markdown files, and it pages them. For example, you may use example-document.md to test Mukette.

mukette example-document.md

Installing

You need ncurses and Flex to build Mukette. ncurses is probably already on your system. But just to be safe:

sudo apt-get install ncurses-dev flex

And then in the the root directory, run make and make install:

make && sudo make install

The man page will be installed alongside. The man page contains all the info about using Mukette:

man 1 mukette

Disclaimer

Mukette is a v1 product, it still has a lot of rough edges. Report any bugs to Issues tab in the Github repository.

Windows

On Windows you can use WSL2 or CygWin/MSys.

mukette's People

Contributors

chubek avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

bircanonal

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.