https://github.com/ojford/kramdown
Markdown specification for CS/math/eng. note-taking
https://github.com/ojford/kramdown
Last synced: 6 months ago
JSON representation
Markdown specification for CS/math/eng. note-taking
- Host: GitHub
- URL: https://github.com/ojford/kramdown
- Owner: OJFord
- Created: 2017-01-15T05:19:38.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-15T06:07:04.000Z (over 8 years ago)
- Last Synced: 2025-02-08T23:28:38.106Z (8 months ago)
- Language: Shell
- Size: 3.91 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kramdown
Kramdown is a markdown specification for [Pandoc](https://github.com/jgm/pandoc) that I find particularly useful for mathematical/engineering subject note-taking.
The name thus comes from reversing the first half of *mark*down, and from ~~kramming~~ cramming for exams with notes written in it.
## Features
The basic Gruber markdown spec for essential formatting - with two changes:
- I prefer to use `/emphasis/` over `*emphasis*`;
- which frees up `*strong_emphasis*` (instead of `**strong_emphasis**`)
Then I add Pandoc's:
- `backtick_code_blocks` for Github-style code sections
- `fenced_code_attributes` for adding language-specific syntax highlighting, or line numbers, etc.
- `tex_math_dollars` for Latex/amsmath `display` sections
- `yaml_metadata_block` for metadata
## Usage
Pipe to `kramdown`; continue as if you've just set `pandoc --from=whatever`:
```sh
cat notes.md | kramdown --to=pdf --output=rendered-notes.pdf
```
## Installation
Download the binary from the [latest release](https://github.com/OJFord/kramdown/releases/latest), and stick it somewhere on your `$PATH` (e.g. `/usr/local/bin/kramdown`).
macOS users should instead just run `brew install OJFord/formulae/kramdown`.