View Source Serum.Project (serum_md v1.6.5)

This module defines a struct for storing Serum project metadata.

Summary

Types

Accepted value for the pretty_urls option

t()

Functions

Creates a new Project struct using the given map.

Types

@type pretty_urls() :: boolean() | :posts

Accepted value for the pretty_urls option

  • false disables pretty URLs.
  • true is currently the same as :posts.
  • :posts enables pretty URLs only for blog posts.
@type t() :: %Serum.Project{
  author: binary(),
  author_email: binary(),
  base_url: binary(),
  date_format: binary(),
  dest: binary(),
  list_title_all: binary(),
  list_title_tag: binary(),
  pagination: boolean(),
  plugins: [Serum.Plugin.plugin_spec()],
  posts_path: binary(),
  posts_per_page: pos_integer(),
  posts_source: binary(),
  pretty_urls: pretty_urls(),
  preview_length: non_neg_integer(),
  server_root: binary(),
  site_description: binary(),
  site_name: binary(),
  src: binary(),
  tags_path: binary(),
  theme: Serum.Theme.t()
}

Functions

@spec default_date_format() :: binary()
Link to this function

default_list_title_tag()

View Source
@spec default_list_title_tag() :: binary()
@spec new(map()) :: t()

Creates a new Project struct using the given map.