Giter VIP home page Giter VIP logo

bridge's Introduction

bridge

Markdown extension for texts related to contract bridge and some half-finished system and convention descriptions.

Syntax

The script does some preprocessing and passes the output to Markdown, so full Markdown syntax is supported. Apart from that, there are several additions:

Symbols

Suit symbols can be written as !C, !D, !H and !S (as in BBO chat). These get converted to appropriate Unicode suit symbols and coloured. For consistency, !N is also provided and is converted to N.

Also, an en-dash can be written as --.

Footnotes

Footnotes are expressed by placing the text where their number should appear, wrapped in curly braces. For example:

This is some text {Footnote goes here.} with a footnote.

Space between the previous word the opening curly brace is optional and ignored. Full Markdown syntax is supported inside footnotes (except nested footnotes).

Usage

The render.sh script takes one argument, the (extended) Markdown input file. It writes its output to stdout. Example usage:

./render.sh docs/system.md > docs/system.html

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.