🍭 Markdown-Blog

GitHub branch checks state GitHub issues Latest Release GitHub license

Markdown-Blog 是一款小而美的Markdown 静态博客程序

markdown

案例

支持平台

Windows 、Linux 、Mac OS

安装

tar zxf markdown-blog-v0.0.2-linux-arm64.tar.gz
cd markdown-blog-linux-arm64
mkdir md
echo "### Hello World" > ./md/主页.md
./markdown-blog web

使用

命令

  • markdown-blog
    • -h 查看版本
    • web 运行博客服务
  • markdown-blog web
    • --dir value, -d value 指定 markdown 文件夹,默认:./md/
    • --title value, -t value web 服务标题,默认:"Blog"
    • --port value, -p value web 服务端口,默认:5006
    • --env value, -e value 运行环境, 可选:dev,test,prod ,默认:"prod"
    • --index value, -i value 设置默认首页的文件名称, 默认为空
    • -h 查看版本

关于默认首页

index

导航排序

字典@

个人博客目录如下图

image

博客导航展示如下图

image

部署

Nginx 反向代理配置文件参考

HTTP 协议

server {
    listen      80;
    listen [::]:80;
    server_name yourhost.com;

    location / {
         proxy_pass  http://127.0.0.1:5006;
         proxy_set_header   Host             $host;
         proxy_set_header   X-Real-IP        $remote_addr;
         proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for;
     }
}

HTTPS 协议( 80 端口自动跳转至 443 )

server {
    listen      80;
    listen [::]:80;
    server_name yourhost.com;

    location / {
        rewrite ^ https://$host$request_uri? permanent;
    }
}

server {
    listen          443 ssl;
    server_name     yourhost.com;
    access_log      /var/log/nginx/markdown-blog.access.log main;


    #证书文件名称
    ssl_certificate /etc/nginx/certs/yourhost.com_bundle.crt;
    #私钥文件名称
    ssl_certificate_key /etc/nginx/certs/yourhost.com.key;
    ssl_session_timeout 5m;
    ssl_protocols TLSv1.2 TLSv1.3;
    ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:HIGH:!aNULL:!MD5:!RC4:!DHE;
    ssl_prefer_server_ciphers on;

    location / {
         proxy_pass  http://127.0.0.1:5006;
         proxy_set_header   Host             $host;
         proxy_set_header   X-Real-IP        $remote_addr;
         proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for;
     }
 }

开发

Golang
make run
make
make package
  1. 生成 Windows 、Linux 、Mac 的压缩包
make package-all

授权许可

本项目采用 MIT 开源授权许可证,完整的授权说明已放置在 LICENSE 文件中。