Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bhznjns/markdown-blog-template

Build your own online knowledge base with markdown!
https://github.com/bhznjns/markdown-blog-template

personal-knowledge-base personal-knowledge-management static-blog-generator static-site-generator

Last synced: 7 days ago
JSON representation

Build your own online knowledge base with markdown!

Awesome Lists containing this project

README

        

![Logo](./src/imgs/favicon.png)

# MarkdownBlogTemplate

[\[็ฎ€ไฝ“ไธญๆ–‡\]](./README_CN.md) [\[Documentation\]](https://bhznjns.github.io/markdown-blog-template/)

Build your own online knowledge base with markdown!

- - -

## ๐Ÿ“– Introduction

The MarkdownBlogTemplate is a static blog website template that can also be used to build a personal online knowledge base. It allows users to write articles in the easy-to-read and understand Markdown format. Unlike popular static website generators like [Hexo](https://hexo.io/zh-cn), [Jekyll](https://jekyllcn.com/docs/home/), [Hogo](https://www.gohugo.org/) , MarkdownBlogTemplate can directly read and render Markdown files on the frontend without the need for server-side rendering.

MarkdownBlogTemplate supports **abundant extra functions of Markdown**:
- ๐Ÿ’ป **Code highlights and tables**: Built-in support for table structures and highlighting of codes in multiple programming languages.
- ๐ŸŽต **Media embedded**: supports special syntaxes for inserting audio and videos.
- ๐Ÿ“ฅ **Independent page embedded**: it is allowed to embed independent page by inlining HTML codes or linking independent HTML file with specific syntax.
- ๐Ÿ”ข **Math formula rendering**: LaTeX rendering library [KaTeX](https://katex.org/) integrated, which makes it convenient to insert math formulas.
- ๐Ÿ“Š **Charts rendering**: With the help of chart rendering libraries like [ECharts](https://echarts.apache.org/zh/index.html) and
[flowchart.js](http://flowchart.js.org/), it is allowed to render charts like bar chart, flow chart, gantt chart with Markdown texts.
- ๐Ÿ”ฒ **QRCode generating**: QRCodes can be easily generated with special Markdown syntax.

## ๐Ÿ”ง Installation

See here๏ผš[Installation โ€”โ€” MarkdownBlogTemplate Documentation](./static/English/installation.md)

Use with [markdown-blog-ext](https://marketplace.visualstudio.com/items?itemName=BHznJNs.markdown-blog-ext) for better experience๐Ÿ˜Š๐Ÿ˜Š