module

Jasper::MarkdownConverter

Class methods

convert_pipe_table_to_html(lines : Array(String)) : String

Converts a list of pipe table lines to an HTML

string

Source
format_summary_line(title : String, summary : String, protect : Bool = true) : String

Formats a 1-sentence method doc comment summary without internal periods in the title, protecting Crystal docs method summaries from truncation.

Source
pipe_table_row?(line : String) : Bool

Checks if a line looks like a markdown table row (e.g. | col1 | col2 |)

Source
pipe_table_separator?(line : String) : Bool

Checks if a line is a markdown table separator (e.g. | :--- | :--- |)

Source
to_doc_comments(markdown : String, indent_level : Int32 = 0, convert_tables : Bool = true) : String

Converts markdown text into Crystal Docs-compliant doc comments, converting pipe tables to HTML tables and indenting lines.

Source

CrystalDocs.org - Crystal Shard Documentation Hosting

The Bushido Collective builds and maintains this site.
Licensed under the Apache License 2.0