Blogger cli is a CLI tool to convert ipynb, md, html file to responsive html files.
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file blogger-cli-1.2.4.tar.gz
.
File metadata
- Download URL: blogger-cli-1.2.4.tar.gz
- Upload date:
- Size: 89.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.12 CPython/3.8.10 Linux/5.10.74.3-microsoft-standard-WSL2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | df2239d452bc307073cdc20ad4093eb682f317e84a728c0e74a13c387a1e09fe |
|
MD5 | 594fe3eac240eedd6070f0384b42e7af |
|
BLAKE2b-256 | c47b4191ab697ff5252d8a60cba98e7e7c4cb8b650810e8f94ccd6af6de7573f |
File details
Details for the file blogger_cli-1.2.4-py3-none-any.whl
.
File metadata
- Download URL: blogger_cli-1.2.4-py3-none-any.whl
- Upload date:
- Size: 117.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.12 CPython/3.8.10 Linux/5.10.74.3-microsoft-standard-WSL2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c7195ce80248e3c26381dc75bfdf0bc519fbef9e9059ddd9b8429b0b410635c |
|
MD5 | c1e761f53626c08ae1db83ba2f88c229 |
|
BLAKE2b-256 | edd4d7e07e36def745d0dcb00765941fc603bf51444d464d0a308becdb897dd9 |