Previous topic

restblog in 5 minutes

Next topic

Getting and installing restblog

This Page

What is the motivation?ΒΆ

The motivation for restblog comes from different open-source projects. I’ll highlight a couple.

reStructuredText is a very simple markup that makes it possible to write extremely effective documentation rendered in many different formats, primarily HTML, from the simplicity of a text file. doctuils is the core set of tools that transforms text into other formats.

Sphinx is a simple and powerful documentation tool that enables developers to quickly put together very effective and professional-looking documentation. The beauty of it is that developers use the very same tool they use for creating code, i.e. a plain-old text editor.

I was inspired by all these tools and wanted to create something that let me blog easily from the comfort of my everyday tools, a simple text editor and a shell. This is not for the exclusive use of developers, but it is perfectly suitable for technical blogging that includes source code because it uses Pygments for syntax highlighting. Besides, docutils takes care of properly escaping all programming symbols that would interfere with regular HTML, e.g. < vs. &lt;.

Finally, I have benefitted many years from many different open-source tools like Python, Sphinx, Pygments, docutils, and so many more that are impossible to list. What is possible to do is return the favor and contribute something back to the open-source community.

This is a humble attempt to pay tribute to all those other developers that have chosen to share some of their code and time in producing tools that have made my personal and professional life better and/or easier.

I hope restblog helps the blogger in you in some meaningful way.

Here are some links to the projects that have inspired and/or have been used as a foundation for restblog: