Skip to content

gass-git/blazed-past-us

Repository files navigation

banner

🚧 Work in progress This framework is still under active development. Expect changes.

Downloads version MIT License

Developer centric static blog framework. Write in Markdown from your IDE, share code and SVGs effortlessly, and ship server-rendered HTML for blazing⚡fast load times.

Live demo

Commit 0

Silver Surfer asked:
"How fast can a dev blog go?"

Gass Git, intrigued, answered:
"I don't know… shall we see?"

Silver Surfer looked dubious and curious:
"Very well… let the cosmos bear witness."

About the framework

  • Designed for static hosting environments (e.g. GitHub Pages) — no server-side rewrites required.
  • Uses hash routing.
  • Fetches static JSON.
  • Fetches HTML fragments.
  • Avoids history API clean URLs.
  • Doesn’t rely on server fallback.

How to write posts ?

  • The post file name will be the title.
  • There is no need to add the title within the .md file, this will be set by the meta data.
  • Post tags are written in every post on the very top as tag1, tag2,...
  • The descriptions of the posts will be a brief showcase of the first paragraph (below the tags).
  • Add svg images by dropping the svg file within the directory src/assets/svgs/ and using the following Markdown native syntax ![whatever](filename.svg)

Useful notes

  • The HTML layout can be modified in src/layout.js
  • Append /#/?tags= to the base URL to filter home page posts by tag.
  • Posts creation dates are persisted.
  • The creation date is not updated when editing a post.
  • The posts titles are used as the identifiers (slugs).

Installation

Set up scaffold:

npx blazed-past-us

Install dependencies:

npm i

Run locally:

npm run dev

For final build:

npm run build

Links of interest

About

Developer centric static blog framework. Write in Markdown from your IDE, share code and SVGs effortlessly, and ship server-rendered HTML for blazing⚡load times.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Contributors