Skip to content

Portable static site generator with frontmatter & math feature, without HTML & JS knowledge.

License

Notifications You must be signed in to change notification settings

LIGMATV/boredown

Repository files navigation

boredown

Simply writing and make site in Markdown without feel stupid for just knowing basic. + It's has perfect Lighthouse score!
Just knowing Markdown? Yeah, just write with it without any complicating features. Knowing HTML? Create the template become what you want. Knowing Javascript? Change anything what you want. Knowing ChatGPT? Ask him.

Boredown was fully using Marked.js for rendering all markdown-styled text like bold, italic, striked. If you're a mad at math, than you're in good company. With Boredown, you can write math by KaTeX.

Boredown has some great built-in features:

  • 🅰️ Easy yet fulfilled accessibility
  • 🔍 SEO at its finest
  • ⚡ Fast performance without reducing
  • 💯 Best practices without making it
  • 🐥 Nice for all use
  • 👁️ Looks the same everywhere
  • 🎨 Customize at all edges
  • 📝 Easily changed by frontmatter
  • ➗ Support math syntax

100 Lighthouse Performance!

Boredown.js has the same concept like TeXMe.js, rendering markdown with the contents in HTML and also supporting math.
Boredown.js prioritize performance and appearance. Instead use MathJax, Boredown using KaTeX for getting an lighter render.

Start make website with Boredown.js

  1. Download this repository to your local storage.
  2. Unzip the boredown-main.zip and open index.html, you will see this simple page.
    2024-11-02 15_29_58-Boredown
  3. You can edit that file and learn it yourself. (Here edited in VSCodium) 2024-11-02 15_31_18-Foto
  4. Start creating another markdown post in HTML extension (like new-post.html, with this simple code:
    <!DOCTYPE html><html lang="en"><script src="boredown.js"></script><textarea hidden>
    ---
    title: Boredown
    date: 2024-11-02
    ---
    Hello world
    
    Open that file and you will see this simple page. 2024-11-02 15_26_36-Boredown

Hope this project can help you ;)

About

Portable static site generator with frontmatter & math feature, without HTML & JS knowledge.

Resources

License

Stars

Watchers

Forks