API Reference literature v#0.4.21
Modules
Provides the core functions to retrieve and manage the CLDR data that supports formatting and localisation.
Parses HTTP Accept-Language
header values as defined in
rfc2616.
Literature Cloudflare
Returns
Backend module that provides functions to define new locales and display human-readable locale names for presentation purposes.
Migrations create the database tables Literature needs.
update @current_version if adding new migration
Beginning tables for Literature
Adds more indexes
Add literature_redirects table
Add language to publications and posts
Add position to literature_tags_posts
Add is_published to literature_posts
Add notes to posts
Add rss fields to publication
Adds more indexes
Adds more indexes
Add update URL for static pages
Add markdown field to posts
Implements cardinal plural rules for numbers.
Implements ordinal plural rules for numbers.
Implements plural rules for ranges
Raised when a page is not found.
Pagination API
Struct for pages metadata
The Literature.Pagination.Paginater
protocol should be implemented for any type that requires pagination.
This plug is responsible for maybe redirecting requests from one path to another inside a publication.
Wrappers around Ecto.Repo
callbacks.
Provides LiveView routing for literature.
Defines a static page generator for a given publication.
Provides a set of functions to automate the generation of static pages such as index,
paginated index, tags, authors, and show pages(see Available Pages
).
It supports customization through options like pagination size, output path, and custom templates.
Static pages are stored in the static_pages_storage_dir
Literature config.
Provides helper functions for the static pages generator in Literature.
Behaviour for static pages layout.
Provides a layout/1
component that can be used for all available static pages.
Helpers for rendering meta tags in static pages.
Behaviour for the templates
opt for Literature.StaticPages.Generator
.
Contains the Phoenix.Component
callbacks for all Generator.page_types()
.
Also contains placeholder implementations for each page type.
Task to convert HTML content in posts to Markdown format. Make sure database version is V12.
Literature Uploaders
Literature Uploaders
Literature Profile Image Uploader
pool boy worker that handles image proccessing and stores it in temp file