https://github.com/yeikiu/vue3-md-blog

✍️ Minimal config Vue3 + Markdown + Bootstrap blog engine
https://github.com/yeikiu/vue3-md-blog

blog blog-theme bootstrap github-actions github-pages markdown typescript vue vue3 vue3-typescript

Last synced: 6 days ago
JSON representation

✍️ Minimal config Vue3 + Markdown + Bootstrap blog engine

• Host: GitHub
• URL: https://github.com/yeikiu/vue3-md-blog
• Owner: yeikiu
• License: cc0-1.0
• Created: 2019-06-12T19:37:08.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-16T12:21:58.000Z (5 months ago)
• Last Synced: 2024-12-06T17:12:05.649Z (17 days ago)
• Topics: blog, blog-theme, bootstrap, github-actions, github-pages, markdown, typescript, vue, vue3, vue3-typescript
• Language: Vue
• Homepage: https://yeikiu.github.io/vue3-md-blog
• Size: 10.1 MB
• Stars: 78
• Watchers: 3
• Forks: 10
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-vue-3 - vue3-md-blog - ✍️ Minimal config Vue3 + Markdown blog engine (Examples)

README

        
  

# ✍️ Minimal config Vue3 + Markdown blog engine

Deploy a fully functional blog made with [Vue3](https://vuejs.org/) + [GitHub Pages](https://guides.github.com/features/pages/)

## 👀 Demo

[https://yeikiu.github.io/vue3-md-blog](https://yeikiu.github.io/vue3-md-blog)

![blog_screenshot](public/blog_store/assets/blog_screenshot.png)

![md_editor_demo](public/blog_store/assets/md_editor_demo.png)

## ⚙️ Main Features:

* Integrated MarkDown editor

* Sync posts with [GitHub Actions](https://docs.github.com/en/actions/getting-started-with-github-actions)

* Posts are compiled from Markdown to html in runtime

* Use [inlined html with bootstrap](https://yeikiu.github.io/vue3-md-blog/#/features/inline-bootstrap-html) classes within your markdown files

* Support for GitHub Pages CSS and emojis

* Dynamic META tags

## 🎬 Quick start

    git clone https://github.com/yeikiu/vue3-md-blog

    cd vue3-md-blog

    npm i

    npm run dev

### Deploy your own blog

Like what you see?

Read the [full guide](https://yeikiu.github.io/vue3-md-blog/#/guide/setup-yor-own-blog) and deploy your own blog in under 5 minutes!

### Next Steps

- [Post and update posts with a simple GIT commit 🕶](https://yeikiu.github.io/vue3-md-blog/#/guide/post-with-a-simple-git-commit)

- Check the [features section](https://yeikiu.github.io/vue3-md-blog/#/features) to see demos of all the cool stuff you can do in your posts!