TableauExcerptExtension

[

• code :: https://github.com/halostatue/tableau_excerpt_extension
• issues :: https://github.com/halostatue/tableau_excerpt_extension/issues

A Tableau extension that automatically extracts excerpts from posts.

Overview

The excerpt extension processes your Tableau posts and extracts excerpts for use in post index pages. Excerpts are stored in the post frontmatter in the same format as the source and rendered with the appropriate converter; for Markdown content, this would be Tableau.markdown/1.

and <!--excerpt:end-->), a split marker (<!--more-->), or extracted using configurable fallback strategies (paragraphs, sentences, or words).

Format-specific processor modules handle paragraph detection for fallback extraction and cleaning of format-specific syntax (footnotes, reference links, or other syntax).

See the guides below for detailed usage and the module documentation for configuration options.

Usage

TableauExcerptExtension mostly works automatically once enabled.

config :tableau, TableauExcerptExtension,
  enabled: true

See the Basic Usage Guide for details on rendering excerpts in your post index pages and the module documentation for configuration options.

Installation

TableauExcerptExtension can be installed by adding tableau_excerpt_extension to your list of dependencies in mix.exs:

def deps do
  [
    {:tableau_excerpt_extension, "~> 1.1"}
  ]
end

Documentation is found on HexDocs.

Semantic Versioning

TableauExcerptExtension follows Semantic Versioning 2.0.