TableauExcerptExtension

[![Hex.pm][shield-hex]][hexpm] [![Hex Docs][shield-docs]][docs] [![Apache 2.0][shield-licence]][licence] ![Coveralls][shield-coveralls]

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

A [Tableau][tableau] extension that automatically extracts excerpts from [posts][posts].

Overview

The excerpt extension processes your Tableau markdown posts and extracts an excerpt for use in post index pages.

If a post already has an excerpt field, it is unmodified. Otherwise, if the

, the excerpt is the content before it. If no marker is found, the first paragraph is chosen. TableauExcerptExtension is markdown-aware and will convert reference links ([link][ref]) to inline links (link) and remove footnotes ([^1]). ## Usage TableauExcerptExtension mostly works automatically once configured. ```elixir config :tableau, TableauExcerptExtension, enabled: true ``` To take advantage of the postexcerpt, post index pages should be updated to render it: ```elixir defmodule MySite.PostsPage do @moduledoc "/posts index page for my site" use Tableau.Page, layout: MySite.RootLayout, permalink: "/posts", title: "All Posts" def template(assigns) do posts = assigns.site.pages |> Enum.filter(& &1[:__tableau_post_extension__]) |> Enum.sort_by(& &1.date, {:desc, Date}) temple do if Enum.empty?(posts) do p do "No posts yet. Check back soon!" end else ul do for post < -posts do li do h3 do a href: post.permalink, do: post.title end if post[:excerpt] && post[:excerpt] != "" do div do Tableau.markdown(excerpt) end end end end end end end end end ``` ## Installation TableauExcerptExtension can be installed by addingtableau_excerpt_extensionto your list of dependencies inmix.exs`: elixir def deps do [ {:tableau_excerpt_extension, "~> 1.0"} ] end Documentation is found on [HexDocs][docs]. ## Semantic Versioning TableauExcerptExtension follows [Semantic Versioning 2.0][semver]. [docs]: https://hexdocs.pm/tableau_excerpt_extension [hexpm]: https://hex.pm/packages/tableau_excerpt_extension [licence]: https://github.com/halostatue/tableau_excerpt_extension/blob/main/LICENCE.md [posts]: https://hexdocs.pm/tableau/Tableau.PostExtension.html [semver]: https://semver.org/ [shield-coveralls]: https://img.shields.io/coverallsCoverage/github/halostatue/tableau_excerpt_extension?style=for-the-badge [shield-docs]: https://img.shields.io/badge/hex-docs-lightgreen.svg?style=for-the-badge "Hex Docs" [shield-hex]: https://img.shields.io/hexpm/v/tableau_excerpt_extension?style=for-the-badge "Hex Version" [shield-licence]: https://img.shields.io/hexpm/l/tableau_excerpt_extension?style=for-the-badge&label=licence "Apache 2.0" [tableau]: https://hex.pm/packages/tableau