diff options
| -rw-r--r-- | ennum.el | 117 |
1 files changed, 116 insertions, 1 deletions
@@ -17,7 +17,122 @@ "Ennum version string") (defvar ennum-blog nil - "Property list specifying ennum publish settings") + "Property list specifying ennum publish settings. + +Valid properties are described below. + +`:working-directory' + +Absolute path to directory containing the blog source code. All +paths (`:posts-directory', `:images-directory', +`:static-directory', `:video-directory' `:other-files-directory', +`:output-directory', `:store', etc.) are interpreted relative to +this path. + +`:output-directory' + +Path to output directory. All output paths (`:atom-feed-file', +`:tag-directory', etc.) are interpreted relative to +`:output-directory'. + +`:posts-directory' + +Source directory with blog posts to publish. All posts in this +directory are exported. If the post contains source blocks that +need to be tangled, the tangled files are written to a +`:static-directory' relative to `:output-directory'. + +`:images-directory' + +Source directory containing images that are linked to. Images +contained in this directory that are also linked to from a post +using the \"image\" link type, or are a poster of a linked to +video file are published. + +`:static-directory' + +Source directory containing linked static files. Static files +that are linked to from a post using the \"static\" link type are +published. Static files not linked to from any post are not +published. + +`:video-directory' + +Source directory containing video files that are linked to. Video +files that are linked to from a post using the \"video\" link +type are published. Video files not linked to from any post are +not published. + +`:other-files-directory' + +Source directory containing other files to publish. org files in +this directory are exported. Other files are copied verbatim. The +directory structure in this directory is mirrored in the output +directory. + +`:tag-directory' + +Output directory to which to write per-tag post +listings. Defaults to \"tag\". + +`:atom-feed-file' + +Path to the Atom feed file. Defaults to \"blog.atom\". + +`:atom-feed-number-of-posts' + +Number of most recent posts to include in the Atom feed. Defaults +to 12. + +`:blog-title' + +Title of the blog. + +`:blog-subtitle' + +Subtitle of the blog. + +`:blog-scheme' + +Scheme of blog URI. Usually, one of \"http\" or +\"https\". Defaults to \"https\". + +`:blog-domain' + +Domain the blog will be published on. For example, +\"example.com\". + +`:blog-license' + +Text declaring the license the blog is published under. For +example, \"All content is licensed under a Creative Commons +Attribution-ShareAlike 4.0 International License.\" + +`:image-width' + +Width to downsize images to. Defaults to 640 pixels. + +`:image-link-width' + +Width of images linked to from downsized images. Defaults to 1024 +pixels. + +`:image-thumbnail-width' + +Width of thumbnail images in post listings. Defaults to 320 +pixels. + +`:locale-alist' + +Association list mapping languages to locales. Defaults +to ((\"en\" . \"C\")). + +`:store' + +Path to the ennum store. The store is a temporary directory used +to cache various versions of built artifacts. It is always safe +to delete. If the store path is relative, it is interpreted +relative to `:working-directory'. Defaults to \".ennum\".") (defvar ennum-track-features '(ennum ennum-html ennum-image ob-tangle org ox ox-html) |