Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,19 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

- Full GFM support

## [0.6.0] (2025-03-?)

Welcome new maintainer @[nobodywasishere](https://github.com/nobodywasishere) who brought support for gfm new features.

- Add matrix platform and Cyrstal version to github action. #[59](https://github.com/icyleaf/markd/pull/59) thanks @[devnote-dev](https://github.com/devnote-dev)
- Correct version check for Crystal::VERSION. #[60](https://github.com/icyleaf/markd/pull/60) thanks @[nobodywasishere](https://github.com/nobodywasishere)
- Add GitHub emoji support. #[61](https://github.com/icyleaf/markd/pull/61) thanks @[nobodywasishere](https://github.com/nobodywasishere)
- Implement strikethrough support. #[62](https://github.com/icyleaf/markd/pull/62) thanks @[nobodywasishere](https://github.com/nobodywasishere)
- [gfm] Add tagfilter option. #[64](https://github.com/icyleaf/markd/pull/64) thanks @[nobodywasishere](https://github.com/nobodywasishere)
- [gfm] Add task list support. #[65](https://github.com/icyleaf/markd/pull/65) thanks @[nobodywasishere](https://github.com/nobodywasishere)
- Add tartrazine render code block. #[67](https://github.com/icyleaf/markd/pull/67) thanks @[zw963](https://github.com/zw963)
- [gfm] Add table support. #[72](https://github.com/icyleaf/markd/pull/72) thanks @[ralsina](https://github.com/ralsina)

## [0.5.0] (2022-06-14)

- Support CommonMark 0.29 #[50](https://github.com/icyleaf/markd/pull/50) thanks @[HertzDevil](https://github.com/HertzDevil).
Expand Down Expand Up @@ -91,7 +104,8 @@ No changelog.

- [initial implementation](https://github.com/icyleaf/markd/milestone/1?closed=1)

[Unreleased]: https://github.com/icyleaf/markd/compare/v0.5.0...HEAD
[Unreleased]: https://github.com/icyleaf/markd/compare/v0.6.0...HEAD
[0.6.0]: https://github.com/icyleaf/markd/compare/v0.5.0...v0.6.0
[0.5.0]: https://github.com/icyleaf/markd/compare/v0.4.2...v0.5.0
[0.4.2]: https://github.com/icyleaf/markd/compare/v0.4.1...v0.4.2
[0.4.1]: https://github.com/icyleaf/markd/compare/v0.4.0...v0.4.1
Expand Down
153 changes: 74 additions & 79 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@
[![Tag](https://img.shields.io/github/tag/icyleaf/markd.svg)](https://github.com/icyleaf/markd/blob/master/CHANGELOG.md)
[![Build Status](https://img.shields.io/circleci/project/github/icyleaf/markd/master.svg?style=flat)](https://circleci.com/gh/icyleaf/markd)


**THIS PROJECT IS LOOKING FOR MAINTAINER**

Unfortunately, the maintainer no longer has the time and/or resources to work on markd further. This means that bugs will not be fixed and features will not be added unless someone else does so.

If you're interested in fixing up markd, please [file an issue](https://github.com/icyleaf/markd/issues/new) let me know.

<hr />

Yet another markdown parser built for speed, written in [Crystal](https://crystal-lang.org), Compliant to [CommonMark](http://spec.commonmark.org) specification (`v0.29`). Copy from [commonmark.js](https://github.com/jgm/commonmark.js).
Expand Down Expand Up @@ -58,6 +51,8 @@ Markd.to_html(markdown, options)
| gfm | `Bool` | false | **Partial support** |
| autolink | `Bool` | false | if **true**, more autolinks are detected, like bare email addresses or http links |
| toc | `Bool` | false | **Not supported for now** |
| emoji | `Bool` | false | if **true**, convert Github style emoji chars. |
| tagfilter | `Bool` | false | if **true**, escape certain HTML tags. |
| base_url | `URI?` | nil | if not **nil**, relative URLs of links are resolved against this `URI`. It act's like HTML's `<base href="base_url">` in the context of a Markdown document. |

## Advanced
Expand Down Expand Up @@ -105,13 +100,13 @@ require "markd"

formatter = Tartrazine::Html.new(
theme: Tartrazine.theme("emacs"),

# Disable print line number
line_numbers: false,

# Set standalone to false for better performace.
#
# You need generate css file use `bin/tartrazine -f html -t "emacs" --css`,
# You need generate css file use `bin/tartrazine -f html -t "emacs" --css`,
# then link it in you site.
standalone: false,
)
Expand All @@ -133,75 +128,75 @@ Currently Tartrazine supports 247 languages and [331 themes](https://github.com/

```crystal
[
"LiquidLexer", "VelocityLexer",
"abap", "abnf", "actionscript", "actionscript_3", "ada", "agda", "al", "alloy", "angular2",
"antlr", "apacheconf", "apl", "applescript", "arangodb_aql", "arduino", "armasm",
"autohotkey", "autoit", "awk",
"ballerina", "bash", "bash_session", "batchfile", "bbcode", "bibtex", "bicep", "blitzbasic",
"bnf", "bqn", "brainfuck",
"c", "c#", "c++", "cap_n_proto", "cassandra_cql", "ceylon", "cfengine3", "cfstatement",
"chaiscript", "chapel", "cheetah", "clojure", "cmake", "cobol", "coffeescript",
"common_lisp", "coq", "crystal", "css", "cue", "cython",
"d", "dart", "dax", "desktop_entry", "diff", "django_jinja", "dns", "docker", "dtd", "dylan",
"ebnf", "elixir", "elm", "emacslisp", "erlang",
"factor", "fennel", "fish", "forth", "fortran", "fortranfixed", "fsharp",
"gas", "gdscript", "gdscript3", "gherkin", "gleam", "glsl", "gnuplot", "go_template",
"graphql", "groff", "groovy",
"handlebars", "hare", "haskell", "hcl", "hexdump", "hlb", "hlsl", "holyc", "html", "hy",
"idris", "igor", "ini", "io", "iscdhcpd",
"j", "java", "javascript", "json", "jsonata", "julia", "jungle",
"kotlin",
"lighttpd_configuration_file", "llvm", "lua",
"makefile", "mako", "markdown", "mason", "materialize_sql_dialect", "mathematica", "matlab",
"mcfunction", "meson", "metal", "minizinc", "mlir", "modula-2", "moinwiki", "monkeyc",
"morrowindscript", "myghty", "mysql",
"nasm", "natural", "ndisasm", "newspeak", "nginx_configuration_file", "nim", "nix",
"objective-c", "objectpascal", "ocaml", "octave", "odin", "onesenterprise", "openedge_abl",
"openscad", "org_mode",
"pacmanconf", "perl", "php", "pig", "pkgconfig", "pl_pgsql", "plaintext", "plutus_core",
"pony", "postgresql_sql_dialect", "postscript", "povray", "powerquery", "powershell",
"prolog", "promela", "promql", "properties", "protocol_buffer", "prql", "psl", "puppet",
"python", "python_2",
"qbasic", "qml",
"r", "racket", "ragel", "react", "reasonml", "reg", "rego", "rexx", "rpm_spec", "rst",
"ruby", "rust",
"sas", "sass", "scala", "scheme", "scilab", "scss", "sed", "sieve", "smali", "smalltalk",
"smarty", "snobol", "solidity", "sourcepawn", "sparql", "sql", "squidconf", "standard_ml",
"stas", "stylus", "swift", "systemd", "systemverilog",
"tablegen", "tal", "tasm", "tcl", "tcsh", "termcap", "terminfo", "terraform", "tex",
"thrift", "toml", "tradingview", "transact-sql", "turing", "turtle", "twig", "typescript",
"typoscript", "typoscriptcssdata", "typoscripthtmldata",
"ucode",
"v", "v_shell", "vala", "vb_net", "verilog", "vhdl", "vhs", "viml", "vue", "wdte",
"webgpu_shading_language", "whiley",
"xml", "xorg",
"yaml", "yang", "z80_assembly",
"LiquidLexer", "VelocityLexer",

"abap", "abnf", "actionscript", "actionscript_3", "ada", "agda", "al", "alloy", "angular2",
"antlr", "apacheconf", "apl", "applescript", "arangodb_aql", "arduino", "armasm",
"autohotkey", "autoit", "awk",

"ballerina", "bash", "bash_session", "batchfile", "bbcode", "bibtex", "bicep", "blitzbasic",
"bnf", "bqn", "brainfuck",

"c", "c#", "c++", "cap_n_proto", "cassandra_cql", "ceylon", "cfengine3", "cfstatement",
"chaiscript", "chapel", "cheetah", "clojure", "cmake", "cobol", "coffeescript",
"common_lisp", "coq", "crystal", "css", "cue", "cython",

"d", "dart", "dax", "desktop_entry", "diff", "django_jinja", "dns", "docker", "dtd", "dylan",

"ebnf", "elixir", "elm", "emacslisp", "erlang",

"factor", "fennel", "fish", "forth", "fortran", "fortranfixed", "fsharp",

"gas", "gdscript", "gdscript3", "gherkin", "gleam", "glsl", "gnuplot", "go_template",
"graphql", "groff", "groovy",

"handlebars", "hare", "haskell", "hcl", "hexdump", "hlb", "hlsl", "holyc", "html", "hy",

"idris", "igor", "ini", "io", "iscdhcpd",

"j", "java", "javascript", "json", "jsonata", "julia", "jungle",

"kotlin",

"lighttpd_configuration_file", "llvm", "lua",

"makefile", "mako", "markdown", "mason", "materialize_sql_dialect", "mathematica", "matlab",
"mcfunction", "meson", "metal", "minizinc", "mlir", "modula-2", "moinwiki", "monkeyc",
"morrowindscript", "myghty", "mysql",

"nasm", "natural", "ndisasm", "newspeak", "nginx_configuration_file", "nim", "nix",

"objective-c", "objectpascal", "ocaml", "octave", "odin", "onesenterprise", "openedge_abl",
"openscad", "org_mode",

"pacmanconf", "perl", "php", "pig", "pkgconfig", "pl_pgsql", "plaintext", "plutus_core",
"pony", "postgresql_sql_dialect", "postscript", "povray", "powerquery", "powershell",
"prolog", "promela", "promql", "properties", "protocol_buffer", "prql", "psl", "puppet",
"python", "python_2",

"qbasic", "qml",

"r", "racket", "ragel", "react", "reasonml", "reg", "rego", "rexx", "rpm_spec", "rst",
"ruby", "rust",

"sas", "sass", "scala", "scheme", "scilab", "scss", "sed", "sieve", "smali", "smalltalk",
"smarty", "snobol", "solidity", "sourcepawn", "sparql", "sql", "squidconf", "standard_ml",
"stas", "stylus", "swift", "systemd", "systemverilog",

"tablegen", "tal", "tasm", "tcl", "tcsh", "termcap", "terminfo", "terraform", "tex",
"thrift", "toml", "tradingview", "transact-sql", "turing", "turtle", "twig", "typescript",
"typoscript", "typoscriptcssdata", "typoscripthtmldata",

"ucode",

"v", "v_shell", "vala", "vb_net", "verilog", "vhdl", "vhs", "viml", "vue", "wdte",

"webgpu_shading_language", "whiley",

"xml", "xorg",

"yaml", "yang", "z80_assembly",

"zed", "zig"
]
```
Expand Down
3 changes: 2 additions & 1 deletion shard.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: markd
version: 0.5.0
version: 0.6.0

authors:
- icyleaf <icyleaf.cn@gmail.com>
- nobodywasishere <margret@eowyn.net>

crystal: ">= 0.36.1, < 2.0.0"

Expand Down
2 changes: 1 addition & 1 deletion src/markd/version.cr
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module Markd
VERSION = "0.5.0"
VERSION = "0.6.0"
end