Code Monkey home page Code Monkey logo

notedown's Introduction

Notedown

Notedown is a little build system to generate nicely formatted computing talk notes. You can comfortably compose the notes in Markdown, and Notedown will wrap it up with some CSS rules to make it more readable.

Configuration

  • $TALK -- Set this to the name of your Markdown file (i.e. $TALK.md). It will also be the name of your output (i.e. $TALK.html).
  • $TITLE -- This is the title of the notes. Watch out: this gets spliced into a sed command, so escape any special sequences.
  • $MDPARSER -- The command to parse the Markdown file. Include all needed flags such that the next token should be the Markdown filename.

Formatting

There are two kinds of code blocks generated by Notedown. Dark gray blocks with green text are meant for shell commands and outputs. They are just regular code blocks in Markdown. White blocks with black text are meant for showing the contents of files. They are code blocks inside blockquotes.

This is regular text.
    $: this_is_a_shell_command
>   This is text in a file.

notedown's People

Contributors

scgruber avatar

Stargazers

JT5D avatar

Watchers

Tim Parenti avatar James Cloos avatar Lin Zhong avatar  avatar Christian Preseau avatar Che-Huai Lin avatar Sroaj Sosothikul avatar Jocelyn avatar Spencer Baugh avatar Ben Scott avatar Ford Seidel avatar

Forkers

imclab

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.