Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hemanta212/blogger-cli
A cli tool to convert and manage jupyter notebook blogs. Proudly host your notebooks even as a static site.
https://github.com/hemanta212/blogger-cli
blog blogger-cli converter customizable html ipynb jupyter jupyter-notebooks notebooks
Last synced: 2 months ago
JSON representation
A cli tool to convert and manage jupyter notebook blogs. Proudly host your notebooks even as a static site.
- Host: GitHub
- URL: https://github.com/hemanta212/blogger-cli
- Owner: hemanta212
- License: mit
- Created: 2019-02-09T03:41:07.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-07-06T21:11:39.000Z (over 2 years ago)
- Last Synced: 2024-09-27T23:41:04.805Z (3 months ago)
- Topics: blog, blogger-cli, converter, customizable, html, ipynb, jupyter, jupyter-notebooks, notebooks
- Language: Python
- Homepage: https://hemanta212.github.io/blogger-cli
- Size: 1.03 MB
- Stars: 414
- Watchers: 5
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nepal - Blogger-cli
README
# Blogger-cli
[](https://pypi.org/project/blogger-cli)
[](https://pypi.org/project/blogger-cli)
[](https://pypi.org/project/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](https://pykancha.github.io/test/)
## 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 ```
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
```
Now, all assets will be moved to the blog_dir you specified in the blog config during setup.
```
$ blogger serve
```
Open the URL http://localhost:8000/ in your browser to view your blog!!
## 📖 Documentation
- [Installation, update, uninstall methods](docs/installation.md)
- [Managing blogs and configurations](docs/blog_management.md)
- [Conversion of files and folders](docs/conversion.md)
- [Serving blog locally](docs/serving_blog_locally.md)
- [Using export command](docs/export.md)
- [Customizing templates and design](docs/customizing.md)
- [Writing blog's metadata](docs/meta.md)
- [Using spellcheck](docs/spellcheck.md)
- [Generating feed for your blog](docs/feed.md)
- [Advanced optional configurations](docs/optional_config.md)
- [Recommended workflow for blogger-cli](docs/workflow.md)
> View docs in: [website](https://hemanta212.github.io/blogger-cli/)
## Author
👤 **Hemanta Sharma**
- Github: [@hemanta212](https://github.com/hemanta212)
## Special Thanks
👤 **Nipun Batra** : Inspiration for core conversion mechanism and design resources.
- Github: [@nipunbatra](https://github.com/nipunbatra)
- His article on ipynb conversion: [@nipunbatra.github.io](https://nipunbatra.github.io/blog/2017/Jupyter-powered-blog.html)
## Show your support
Please ⭐️ this repository if this project helped you!
## 📝 License
Copyright © 2019 [Hemanta Sharma](https://github.com/hemanta212).
This project is [MIT](LICENSE) licensed.
---