Giter Club home page Giter Club logo

org_reader's Introduction

Org Reader

Publish Emacs Org files alongside the rest of your website or blog.

  • ORG_READER_EMACS_LOCATION: Required. Location of Emacs binary. If you use Emacs for Mac OS X, the location should be /Applications/Emacs.app/Contents/MacOS/Emacs, rather than /usr/bin/emacs.

  • ORG_READER_EMACS_SETTINGS: Optional. An absolute path to an Elisp file, to run per invocation. Useful for initializing the package Emacs library if that's where your Org mode comes from, or any modifications to Org Export- related variables. If you want to use your standard emacs init file, you can ignore this variable.

  • ORG_READER_BACKEND: Optional. A custom backend to provide to Org. Defaults to 'html.

To provide metadata to Pelican, the following properties can be defined in the org file's header:

#+TITLE: The Title Of This BlogPost
#+DATE: 2001-01-01
#+CATEGORY: blog-category
#+AUTHOR: My Name
#+PROPERTY: LANGUAGE en
#+PROPERTY: SUMMARY hello, this is the description
#+PROPERTY: SLUG test_slug
#+PROPERTY: MODIFIED [2015-12-29 Di]
#+PROPERTY: TAGS my, first, tags
#+PROPERTY: SAVE_AS alternative_filename.html
  • The TITLE is the only mandatory header property
  • Timestamps (DATE and MODIFIED) are optional and can be either a string of %Y-%m-%d or an org timestamp
  • The property names (SUMMARY, SLUG, MODIFIED, TAGS, SAVE_AS) can be either lower-case or upper-case
  • The slug is automatically the filename of the Org file, if not explicitly specified
  • It is not possible to pass an empty property to Pelican. For this plugin, it makes no difference if a property is present in the Org file and left empty, or if it is not defined at all.

org_reader's People

Contributors

linevych avatar

Stargazers

 avatar

Watchers

 avatar

org_reader's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.