Skip to content
Karl Voit edited this page Oct 8, 2017 · 18 revisions

Why lazyblorg and not <another project>?

Please do read the sections “Why lazyblorg” and “Advantages” above.

Does lazyblorg cost anything?

No.

Although, please do respect the license which is attached to this project.

As with every open source project, you will find that there are some costs: your time. However, you will gain additional knowledge from coping with it. :-)

Am I able to use lazyblorg for myself?

Yes.

Get it from github and read the installation notes in this file.

What Org-mode elements are supported by lazyblorg?

The Python parser implements a sub-set of Org-mode syntax. See Orgmode Elements for a list of supported elements. As a fall-back for all other Org-mode elements, pandoc is used which works quite well.

An Org-mode test-file (for unit testing) containing all implemented Org-mode syntax elements can be found here.

This test-file produces an example HTML entry that can be found here.

Where can I find support for lazyblorg?

In short: please do help yourself. :-)

Long: I developed lazyblorg for my own purposes and therefore it is optimized for my own requirements only. If you find lazyblorg cool and you want to use it on your own, I am totally OK with that. However, I can not offer much time in supporting other requirements than my own. If you did not catch this by yourself: I am lazy.

Is lazyblorg in active development? What are the future plans?

This section was updated on 2016-11-18:

Currently: yes (heavy) :-)

My general plan:

  • Add features to lazyblorg as long as I feel the urge to.
  • Be open to enhancements done by others on github.
  • If lazyblorg reaches a state, where I do not need anything additional, let’s keep it that way: development stopped because it reached sufficient perfection :-)

See also Roadmap with all kind of information about the development (plans, documentation, …).

Already accomplished:

  • develop lazyblorg to be able to replace my current web page and its blog.
  • ATOM/RSS
  • tag-pages
  • Auto-tags
  • lists
  • Pandoc fall-back for unknown Org-mode elements
  • include image files

Next:

  • overview pages (monthly, yearly)
  • more auto-tags
  • internal refactoring (object containing all constants, …)

Is there any documentation about the internals of lazyblorg?

Yes, please do read the Wiki.

Lazyblorg uses what technology?

  • input files: Org-mode files of version 8.x or higher
  • processing: Python 2.x
    • some dependencies on libraries, nothing fancy
    • I started with Python 2.x and never got the tension to test Python 3.x so far
  • output files: static HTML5, CSS3

Why didn’t you use HTML export/org-publish/Elisp/…?

Please do read my statement on GitHub.

Isn’t this quite slow?

As with 2016-11-18, the parser and htmlizer is performing pretty well in my opinion. When I re-generate my whole blog, I currently get this summary output:

Parsed 19 Org-mode files with 500483 lines (in 4.29 seconds)
Generated 402 articles: 10 persistent, 300 temporal, 91 tag, 1 entry page (in 7.93 seconds)

Can I use the Org-mode parser (in Python) for other purposes as well?

Yes, please do read the Wiki and lib/orgparser.py.

Although, you have to modify it a bit since I filter out headings that meet the criteria of being a blog article. You also have to know that I did not write a clean parser (separate lexical and syntactic analysis) for Org-mode. I used the naive line-by-line method in order to get the sub-set Org-mode syntax done quickly. There certainly is a downside of this method in terms of capability and probably also maintainability.

Please also note that this parser only implements a sub-set of Org-mode syntax (see Orgmode Elements). For the rest, I am using Pandoc which works quite well.

If you are looking for other or more general Org-mode syntax parsers, please do read this page.

I do have a question but it is not listed here. Where to ask?

Just drop me a line: lazyblorg <at-sign> Karl <minus-sign> Voit <dot> at

Clone this wiki locally