rootbeerSSG 1.0.1

Description:

rootbeerSSG 1.0.1

RootbeerSSG 🍺
The easy to use and very epic static site generator for blogs!
Just think of the emoji above as a glass of rootbeer ok?













What is RootbeerSSG? 🤔
RootbeerSSG (or Rootbeer as I call it 100% of the time) is a SSG that specilises in making static blogs.
It can easily integrate with things like Staticman. You can also quickly deploy it to the free hosting platform Netlify
Rootbeer is aimed for people who are new too things like Static Site Generators and strives to make it as easy as possible.
How to download Rootbeer 🔻
It's easy!
All you have to do is open a terminal and put this line into it:
pip install rootbeerSSG

Or
python -m pip install rootbeerSSG

Or
python3 -m pip install rootbeerSSG

Running on your machine 💻:
The recommended way to install Rootbeer is to make a Virtual Envrionment. You will need a package called venv
If you don't have the venv module, you can install it like this:
pip install venv

You can do so by putting this in your console:
python -m venv env

and it will create a folder called env. You can call it whatever you want.
Now to activate it, in your console run
env\Scripts\activate

if you are on Windows.
Great! You have your virtual environment!
If you want to deactivate the virtual environment, just run
deactivate

How to use Rootbeer 💡
All you have to do is:
from rootbeerSSG import RootbeerSSG

rb = RootbeerSSG()

and run the file!!!
Then write away! For more info, take a look at the Wiki section on the GitHub.
Rootbeer has two types of content: pages and posts. pages are, well, you know. Pages.
posts are the things you write and are stored in the blog folder.
Rootbeer supports Markdown for the posts and pages. They will be rendered into HTML.
How to preview your site on your local machine 🍃
You can do this in your terminal:
cd public

and then:
python -m http.server

and then you can go too localhost:8000 and BOOM! You have your site running!
How customizable is Rootbeer? 🎨
How does PLUGINS and THEMES sound?
See the Wiki for more info.
Why tho???
Because I felt like it lol and WordPress hosting is the monez