API

Creates a new site skeleton with a few posts.

Converts the pathname to the form that should be used to write content to the disk.

If the site has the clean-urls setting enabled, then the filename like some/page.html will be converted to some/page/index.html. If clean-urls is not enabled, the pathname will remain unchanged.

Converts the URL to the form that should be used on the site.

If the site has the clean-urls setting enabled, then the URL like /some/page.html will be converted to /some/page/. If clean-urls is not enabled, the URL will remain unchanged.

Absolute pathname to the file read from disk or NIL for content objects which have no source file, like RSS feeds.

A hash with additional fields specified in the file's header.

This generic-function is called for every content item found on disk and can return a list of additional content items such as images or files mentioned in the CONTENT argument.

Should return an absolute pathname to a file where this content item should be rendered.

Returns T if content has a given TAG-NAME. For content which does not support tags, returns NIL.

Returns T if CONTENT is inside the given PATH.

Returns a list of content objects corresponding to a given content type.

EXCLUDE argument is a list of pathname prefixes to ignore. Pathnames should be given relative to the root dir of the site.

Returns a list of content objects loaded from files.

EXCLUDE argument is a list of pathname prefixes to ignore. Pathnames should be given relative to the root dir of the site.

Returns a list of content-type objects.

Writes CONTENT object to the STAGE-DIR.

Writes CONTENT object to the STREAM using given FORMAT.

Changes metadata dictionary by adding a new item with key KEY.

Key should be a string and it is automatically downcased.

Note, this way, you can override content's object slots. To prevent accidential override, function will raise an error in case if a slot named KEY exists in the object CONTENT. To force override provide OVERRIDE-SLOT argument.

Reads content from the disk.

By default only post and page files are loaded. But this list could be extended if you'll define a custom site class and a method for staticl/content:supported-content-types generic-function.

Represents a file on the disk. Usually this will be an image or some other asset which should be published along the main content.

Returns a content as HTML string.

If ABSOLUTE-URLS argument is T, then links to media files will be rewritten to be absolute, starting from https://.

Returns an excerpt of full content as HTML string.

If ABSOLUTE-URLS argument is T, then links to media files will be rewritten to be absolute, starting from https://.

Returns T if there is more content than was returned by content-html-excerpt generic-function.

This is the class for a page which will not be included into the feed and indices.

Returns T if given object is a content of post class.

Returns a plist of metadata from FILE with :TEXT holding the content going after the SEPARATOR.

Creates an XML feed in Atom format at TARGET-PATH.

Only a LIMIT latest posts are included into the feed.

Creates an XML feed in Rss format at TARGET-PATH.

Only a LIMIT latest posts are included into the feed.

Filters input content objects and processes them using pipeline items given as a body.

Arguments:

• PATH: result will contain only items read from the given path.

• TAGS: result will contain only items having all given tags.

• INVERT: inverts effect of the filter.

• PIPELINE: any number of function calls returning pipeline nodes.

Note: Right now, all new items generated by PIPELINE given to the filter macro are added to the toplevel list and stay invisible to the sebsequent pipeline nodes. The same applicable to content deletion.

Extracts additional content from the text. For example, if markdown content includes an image, this generic-function should return a list with an object of staticl/content/file:file class. This way an image will be copied to the output directory.

Should render TEXT in given FORMAT as HTML.

If ABSOLUTE-URLS argument is specified, then CONTENT-URL also should be specified.

Relative pathname to a directory where all pages will be generated.

Relative pathname to a file with page content.

A title of the page.

A callback to change page titles.

Accepts single argument - a page number and should return a pathname relative to the site's root. By default, it returns index.html for the first page and page-2.html, page-3.html for others.

If site has "clean urls" setting enabled, then additional transformation to the pathname will be applied automatically.

A callback to change page titles.

Accepts single argument - a page number and should return a string.

For example, here is how you can translate page title into a russian:

(paginated-index :target-path #P"ru/"
                 :page-title-fn (lambda (num)
                                  (fmt "Страница ~A" num)))

Creates additional HTML files with post's excerpts grouped by PAGE-SIZE items.

By default index.html, page-2.html, page-3.html, etc. filenames are used, but this can be overriden by PAGE-FILENAME-FN argument.

The same way page title may be overriden by providing a function as PAGE-TITLE-FN argument.

Arguments:

PAGE-FILENAME-FN:

A callback to change page titles.

Accepts single argument - a page number and should return a pathname relative to the site's root. By default, it returns index.html for the first page and page-2.html, page-3.html for others.

If site has "clean urls" setting enabled, then additional transformation to the pathname will be applied automatically.

PAGE-TITLE-FN:

A callback to change page titles.

Accepts single argument - a page number and should return a string.

For example, here is how you can translate page title into a russian:

(paginated-index :target-path #P"ru/"
                 :page-title-fn (lambda (num)
                                  (fmt "Страница ~A" num)))

A callback to change page titles.

Accepts single argument - a tag name and should return a pathname

By default, for tag "foo-bar" it returns foo-bar.html.

If site has "clean urls" setting enabled, then additional transformation to the pathname will be applied automatically.

A callback to change page titles.

Accepts single argument - a tag name and should return a string.

For example, here is how you can translate page title into a russian:

(tags-index :target-path #P"ru/"
            :page-title-fn (lambda (tag-name)
                             (fmt "Записи с тегом ~A" tag-name)))

Creates additional HTML files with post's excerpts grouped by tag names.

By default some.html, another.html filenames are used, but this can be overriden by PAGE-FILENAME-FN argument.

The same way page title may be overriden by providing a function as PAGE-TITLE-FN argument.

Arguments:

PAGE-FILENAME-FN:

A callback to change page titles.

Accepts single argument - a tag name and should return a pathname

By default, for tag "foo-bar" it returns foo-bar.html.

If site has "clean urls" setting enabled, then additional transformation to the pathname will be applied automatically.

PAGE-TITLE-FN:

A callback to change page titles.

Accepts single argument - a tag name and should return a string.

For example, here is how you can translate page title into a russian:

(tags-index :target-path #P"ru/"
            :page-title-fn (lambda (tag-name)
                             (fmt "Записи с тегом ~A" tag-name)))

Adds a piece of HTML to the list of pieces to be inserted to a given point when content will be rendered to a file.

Creates a link to the given content piece.

When such object is passed to the template, it is resolved to a page URL and title.

Creates a links between pages.

Links are added to the content item's metadata and available in templates as content.prev.url and content.next.url variables.

A method for this generic function should process CONTENT-ITEMS - a list of conten items produced by a previous pipeline nodes.

During the execution, method can call produce-item or remove-item functions to add a new content or to remove some content item.

Enables Disqus on the page.

To make it work, you have to register your site at Disqus and provide a short site name to the function.

Enables MathJAX on the page if it's content has tag equal to the TAG-NAME or if FORCE argument was given.

This generic-function is called to filter out items which should not be visible in the sitemap. Examples of such content are different assets files.

Default method returns T.

Generate some-page/index.html instead of some-page.html to make URLs look like https://my-site.com/some-page/ instead of https://my-site.com/some-page.html

Site's charset. By default it is UTF-8.

A directory pathname where .staticlrc file can be found.

Site's description.

Site's navigation.

A list of pipline nodes

A theme object for the site.

Site's title.

Site's URL.

Creates a new site skeleton with a few posts.

Copies static files such as CSS, JS, images into the STAGE-DIR.

Usually it is enough to define a method for list-static generic-function.

Returns a list of static files such as CSS, JS, images.

Each list item should be a list of two items where first item is an absolute pathname and second is a pathname relative to the root of the site.

Renders fills template named TEMPLATE-NAME with given VARS and renders into a given STREAM.

• NAME argument is a string.

• VARS argument is a hash table with string keys.

Fills a hash-table given as HASH argument with variables for filling a template.

If hash is NIL, then a new hash-table should be allocated with EQUAL :TEST argument.

Returned hash-table will be used for rendering a template for an OBJECT.

Returns a full object URL. A method should return an relative URL, but in case if FULL argument was given, the full url with schema and domain will be returned.

Note a call to this method should happen in a context of the with-base-url macro, because it is always return a path from the site's root even if FULL is not given (in this case return only the path without a domain).

You may wonder: "Why does we bother to return a path without a domain?" It is much easier to service such static site locally for debugging purpose, because you don't have to setup a web server and dns resolver.

Actually you will need to use FULL argument only in a rare case when you really need and absolute URL, for example in an RSS feed.

It CLEAN-URLS argument is T, then additional transformation will be applied to the url.

Returns a new list where each value is replaced with results of call of normalizing functions.

For example:

CL-USER> (normalize-plist '(:foo "Bar" :blah 123)
                          :foo (lambda (value)
                                 (alexandria:make-keyword (string-upcase value))))
(LIST :FOO :BAR :BLAH 123)

For each file under ROOT-PATH, run BODY. If FILE-TYPE is provided, only run BODY on files that match the given extension.