Skip to content

catzy007/stevia-page

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

65 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stevia Page

Vanilla.Js + Markdown = ❤️

Create your blog without databases

This is website (blog) template that serves static page encoded in Markdown. At the heart it uses ShowdownJS, Vanilla.js and XMLHttpRequest API (XHR).

Directory structure

.
├── assets
├── css
├── fonts
├── js
├── sm
├── pages
│   ├── your-custom-page
│   │   └── content.md (put your page content here)
│   ├── about
|   │   └── content.md (about page content)
|   ├── contact
|   │   └── content.md (contact page content)
|   └── index.md (page index)
└── posts
    ├── YYYY-MM-DD-post-title-you-want-to-create
    │   ├── content.md (put your post content here)
    │   ├── thumbnail.jpg (post thumbnail)
    │   ├── picture.jpg (post image)
    │   └── document.doc (downloadable document)
    └── index.md (post index)

To make new posts, do (for Git users)

  1. Clone this git.
  2. Go to posts and make new directory with format (lowercase).
YYYY-MM-DD-post-title-you-want-to-create
  1. Go to directory you just made and create content.md.
  2. Fill content.md with your content using Markdown format.
  3. Create thumbnail.jpg file with 4:3 aspect ratio.
  4. Then open /posts/index.md and add directory name YYYY-MM-DD-post-title-you-want-to-create to posts index.
  5. Git add, commit, and push.
  6. If CI/CD is set, the blog will automatically get updated.

Make sure only using 1234567890abcdefghijklmnopqrstuvwxyz and - as index separator

Pros

  • Write in any platform as long as git and text editor is available.
  • No need to install additional tools like Hugo & Jekyll.
  • No need to regenerate static page after content update.
  • Markdown Directives and standard HTML tag is supported for more customization.

Cons

  • There are an edge case where spacing and layout may require additional step such as using Markdown Directives and standard HTML.