Skip to content

Ali-Frh/GrapeBlog

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GrapeBlog 🍇

Development Status License
a Simple Static Blog Generator

out
Demo: https://Ali-Frh.github.io/GrapeBlog

WTF Is This ?

GrapeBlog is a simple static blog generator, that's it!
I'm always interested in writing blog posts, but also I have concerns about keeping them as free as possible,
On the other hand, I find Github Pages a great opportunity for static backend-less web pages to share their knowledge without any concern.
and for this goal, I found a project named Jekyll which I find it very complicated and even not compatible with RTL Languages, so long story short I wanted to make a Jekyll alternative with less complexity without ruby-crap and stuff.

Key Features:

Performance ⚡

Nothing is faster than vanilla HTML and CSS!

Security 🛡️

No backend = No vulnerability

Easy to Use 👌

Just write your Post and Build it.

Supports different Themes 🖼️

Currently has Default RTL Theme.

Comment System 💬

Who says static websites can't have comment system ?!

Project State:

Version 1.2 Released.
Version 1.3 Under Development.

Notes:

  1. If You want to use Github Pages with GrapeBlog, there is a important thing that you should know:
    Github Idiotically Consider our Export (and maybe any static html file) as Jekyll Export and builds it with Jekyll builder
    and because we are not based on Jekyll, it fails and you see a 404 page instead of your Magnificent Blog.
    Solution: You have to make a file in / directory of your repo, with '.nojekyll' name to inform github that we are not using Jekyll.
    (i'll change the script to cover this issue and make this file in the generated files)

    Script Covers this and you just have to don't mess with the .nojekyll file.
  2. We use python-markdown package as markdown parser, Here is the Syntax document of it's accent. (note that in this Markdown Accent you have to Use two spaces at the end of the line for newline effect)
  3. Do not Change Your Posts' Slug! Because our comment system linked to post's filename (Date_Slug) and if you change it you will lose your previous comments. (its fine for posts with no comments though).

Road Map:

In order of priority
════════ Start ! ════════╕
☑️ Choose Proper Licence
☑️ Candy-ass Terminal Responses
☑️ Simplify adding Custom Pages
☑️ Screenshots and Demo
═══════ ᴠᴇʀꜱɪᴏɴ ₁.₀ ═══════╛
☑️ Jalali Calendar
═══════ ᴠᴇʀꜱɪᴏɴ ₁.₁ ═══════╛
☑️ Increase GTMetrix of Default Template
☑️ Image Optimizer (Convert & Compress)
☑️ 404 Page
═══════ ᴠᴇʀꜱɪᴏɴ ₁.₂ ═══════╛
⬜ Sitemap, rss
⬜ Build Date Timestamp
⬜ Simple Usage Guide
⬜ Cross Platform Support
⬜ Following PEP-8 Pattern
⬜ Make LTR Template
⬜ Make Wiki and Theming Guide
⬜ Assets Watermarker
⬜ Design Another Themes
⬜ Human Friendly gh-pages Deployer
⬜ Add Useful Comments (in code)
⬜ Make Cli Tool
⬜ Post Recovery Tool
⬜ Control through Web UI
₀₁₂₃₄₅₆₇₈₉

Thanks To:

  • Jekyll Project for inspiration
  • Cusdis Project for Comment Section
  • jdf.scr.ir for Jalali Date Convertor
    forthebadge made-with-python