Blogger-cli

A custom CLI tool to process jupyter notebooks, markdown files and HTML files. Write your blog in markdown or jupyter notebooks and then transform into a blog post with mathjax, code support, google analytics, navigation, Disqus support.

See a sample blog made by blogger-cli: Here

Why?

It is easy to get your hands on, works flawlessly and won't get bulky and slow over time. Blogger-cli has a simple conversion system that is fast as well as extremely customizable.

Features

• Robust conversion of ipynb notebooks with great support for mobile devices as well.
• Built-in support for Disqus, google analytics, navigation bar, social sharing, mathjax and code highlighting.
• Support for spell checking, live server and generation of RSS/Atom feeds.
• Blog management: updating the index file, parsing out images, managing topics and metadata.
• Write and post blogs from android or any microdevice. All that is required is command line with python and pip.
• Built-in design, blog_templates for rapidly setting up your blog from scratch.
• Fully customizable with support for custom themes and templates.
• Also support conversion of other file formats like markdown. You can also implement your own.

💻 Installation

Recommended Method

$ curl -sSL https://hemanta212.github.io/blogger-cli/get_blogger.py | python

Since blogger has a lot of dependencies (nbconvert, jupyter), this custom installer will install them in a virtual environment and add it to your path for global access.

Using pip

pip install blogger-cli

If you mainly use jupyter notebooks, then you already have all the required dependencies although it is recommended to use virtual environments.

🚀 Getting Started

Make a website repository and clone it to your computer. Now register your blog name with blogger $ blogger addblog <blogname> and set up the necessary configs. Now, If you have a new site or an empty site. You can get blogger default design and boilerplate.

$ blogger export blog_layout -b <blogname>

Now, all assets will be moved to the blog_dir you specified in the blog config during setup.

$ blogger serve <blogname>

Open the URL http://localhost:8000/ in your browser to view your blog!!

📖 Documentation

• Installation, update, uninstall methods
• Managing blogs and configurations
• Conversion of files and folders
• Serving blog locally
• Using export command
• Customizing templates and design
• Writing blog's metadata
• Using spellcheck
• Generating feed for your blog
• Advanced optional configurations
• Recommended workflow for blogger-cli

View docs in: website

Author

👤 Hemanta Sharma

• Github: @hemanta212

Special Thanks

👤 Nipun Batra : Inspiration for core conversion mechanism and design resources.

• Github: @nipunbatra
• His article on ipynb conversion: @nipunbatra.github.io

Show your support

Please ⭐️ this repository if this project helped you!

📝 License

Copyright © 2019 Hemanta Sharma.
This project is MIT licensed.