class Markdown::File

• Markdown::File
• Reference
• Object

Overview

A class representing a Markdown file

Direct Known Subclasses

• Books::BookChapter
• Gallery::Gallery
• HTML::File
• Pandoc::File

Defined in:

markdown.cr

Constructors

• .new(sources : Hash(String, String), base : Path)

  Initialize the post with proper data

Class Method Summary

• .posts

Instance Method Summary

• #<=>(other : File)
• #_replace_shortcodes(text : String) : String
• #breadcrumbs(lang = nil)

  What to show as breadcrumbs for this post

• #date : Time | Nil
• #dependencies : Array(String)

  List of all files and kv store items this post uses

• #full_shortcodes_list(text)

  Parse shortcodes in the text recursively

• #html(lang = nil)
• #language_links(lang : String | Nil = nil)

  Get language alternate links for this post Returns an array of Hash for Crinja compatibility

• #link(lang = nil)
• #load(lang = nil) : Nil

  Load the post from disk (for current language only)

• #metadata(lang = nil)
• #output(lang = nil)
• #related_posts(lang = nil)

  Get related posts based on similarity

• #rendered(lang = nil)

  Render the markdown HTML into the right template for the fragment

• #replace_shortcodes(lang)
• #shortcodes(lang = nil)
• #show_updated?(lang = nil)

  Check if the updated date should be shown (at least 1 minute different from post date)

• #source(lang = nil)
• #summary(lang = nil)
• #taxonomies
• #taxonomy_terms(lang = nil)
• #template(lang = nil)

  Path for the Templates::Template this post should be rendered with

• #text(lang = nil)
• #title(lang = nil)
• #to_s(io)
• #toc(lang = nil)
• #value(lang = nil)

  Return a value Crinja can use in templates

Constructor Detail

Class Method Detail

Instance Method Detail