{"id":13789262,"url":"https://github.com/xusenlin/forest-blog","last_synced_at":"2025-12-15T10:57:56.555Z","repository":{"id":38375818,"uuid":"183765328","full_name":"xusenlin/forest-blog","owner":"xusenlin","description":":seedling:ForestBlog 是基于 go 语言开发的，适合用来学习和展示 markdown 文档的精美博客:)","archived":false,"fork":false,"pushed_at":"2023-08-09T01:59:46.000Z","size":5160,"stargazers_count":106,"open_issues_count":0,"forks_count":24,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-03-24T15:02:59.818Z","etag":null,"topics":["blog","forestblog","golang"],"latest_commit_sha":null,"homepage":"http://xusenlin.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xusenlin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-04-27T11:40:40.000Z","updated_at":"2025-02-15T13:46:24.000Z","dependencies_parsed_at":"2024-01-19T17:01:37.797Z","dependency_job_id":"5429db42-c28f-44bb-994f-9d083b71ef85","html_url":"https://github.com/xusenlin/forest-blog","commit_stats":{"total_commits":78,"total_committers":4,"mean_commits":19.5,"dds":"0.15384615384615385","last_synced_commit":"009ba7688017dd337d96a60421a1119dc157d845"},"previous_names":["xusenlin/go_blog","xusenlin/forestblog"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xusenlin%2Fforest-blog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xusenlin%2Fforest-blog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xusenlin%2Fforest-blog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xusenlin%2Fforest-blog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xusenlin","download_url":"https://codeload.github.com/xusenlin/forest-blog/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253682508,"owners_count":21946949,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog","forestblog","golang"],"created_at":"2024-08-03T21:01:00.788Z","updated_at":"2025-12-15T10:57:56.499Z","avatar_url":"https://github.com/xusenlin.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# forestBlog\n\n\u003e forestBlog 是使用本地 git 仓库的 markdown 文章来驱动的精美博客。\n\n\n:chestnut:  [xusenlin.com](http://xusenlin.com) （个人博客，正在使用）\n\n:point_right:  [github.com/xusenlin/ForestBlog](https://github.com/xusenlin/ForestBlog)\n\n---  \n\n## 项目背景\n博客从最早的静态 Html+Css 主页到 Wordpress 、Typecho 、Hexo 、Hugo 一路尝试过来，虽然他们都是很优秀的开源项目，但是没有一款符合我内心真正的诉求。\n他们有的要么太重了要么部署不方便要么对存储的文章不友好，我就放弃了之前在Typecho上的文章，同时调整分类也不那么灵活，有的迁移也不方便。\n自己太懒，不想自己做文章备份，不想安装数据库，快速响应也是必须的，所以才有了用 GOLANG 来写一个简单博客的想法。\n当然，自己的这个项目并不能和这些优秀的开源项目相比较，它只是符合我自己的诉求顺便用来学习GOLANG的项目。(写文章也能增加github的活跃度，逃 :))\n\n## ForestBlog 在做什么\n\n\n简单来说，ForestBlog 会使用 git 将你的 .md 文档仓库克隆到当前目录下, 然后并行加载和解析文章关键信息并生成内容，呈现一个博客站点。\n当你向你的 git 仓库提交文章的时候，你可以设置 webHooks 来自动通知 ForestBlog 更新同步文章，或者可以在仪表盘里手动更新文章。\n\n\n## 安装\n\n你可以克隆当前仓库，然后在 JSON 文件里面配置好你文档的 Git 地址，编译源代码并放入后台运行。\n\n\n## 使用\n\n- 配置好 config.json 文件，详细的配置说明文件在当前仓库根目录的《配置说明.md》\n- 新建一个 git 仓库，用来存放你的文章，但是对你的目录结构有一些要求\n如下：\n```\n    |-- assets       //博客静态文件，存放一些图片资源，方便显示到文档里\n    |-- content\n    |   |-- GOLANG   //分类目录\n    |       |-- GOLANG基础   //  子分类目录，但是在页面上不会产生分类目录\n    |       |--- GOLANG基础语法.md   \n    |   |-- 其他分类\n    |       |--- xxx.md\n    |-- extra_nav  // ForestBlog只会有 Blog Categories Tags 三个导航，其他导航可以放到这个目录下，比如自己的简历，作品之类的\n    \n```\ncontent目录下的一级目录代表一个分类，如果一级目录下有子级目录也不会产生新的分类,子级目录的文档也会属于一级目录的分类。\n\n- 每一篇文章的开头可以配置一些文章的属性，具体可以看 配置说明.md\n如下：\n```\n    ```json\n    {\n        \"date\":\"2019.01.02 14:33\"，//最少需要\n        \"tags\": [\"BLOG\"，\"其它tag\"]，//可以不填，不过最好添加一些tag，后面可以做一些好玩的东西。\n        \"title\": \"文章的标题，一般不用填写，默认使用文件名\"，\n        \"description\": \"文章描述，不填写自动取正文200个字，可以在app.json中配置\"，\n        \"author\": \"xusenlin\"， //文章作者，可以不用填写，现在也没有使用到\n        \"musicId\":\"网易云的音乐ID\" //阅读文章时可以播放的歌曲\n    }\n    ```\n```\n我会根据关键字```json来解析，不用担心这个会显示到文章内容里面，我在解析的时候就将它去掉了。\n如果不再文章前面添加这一段json也是可以的，不过我不建议这么做，因为这样就和V1.0版本没什么区别了，没有了文章属性，排序都是个问题。\n\n\n\u003e 提示：```json 前面不能有其它字符。\n\n- 切换主题色和搜索文章在仪表盘里，访问/admin 可以查看仪表盘，\n如果不想让别人知道你的仪表盘地址可以自己配置dashboardEntrance字段。\n\n\n## TODO\n- [x] 1.移动端更好的适配\n- [x] 2.根目录可以添加其他文件生成导航\n- [x] 3.仪表盘支持切换主题色\n- [x] 4.仪表盘支持搜索\n- [x] 5.tags的展示 @pan-jf \n- [x] 6.仪表盘添加手动更新文章功能\n- [x] 7.添加webHook支持(去掉自动更新)\n- [x] 8.添加评论支持(在配置里开启，所有评论都会储存在仓库的Issues)\n- [x] 9.支持网易云音乐\n\n\u003e 后续尽善尽美之后，我可能会提供其他漂亮的主题皮肤，也欢迎大家参与进来。\n\n## 特性\n\n1. 响应迅速  ---得益于GOLANG的运行速度，部署在阿里云的博客平均响应在50毫秒内。\n2. 迁移方便  ---GOLANG交叉编译可以方便的发布二进制文件到不同的操作系统，执行二进制文件自动克隆博客即可运行你的博客。\n3. 小巧精美  ---非常简单的代码方便学习和改造，即使有一天你厌倦ForestBlog，你的文章也能很好的迁移和阅读。\n4. 分类调整  ---随时调整你的文章分类，你可以把一个文件夹里所有的东西移动到其他分类里的某个地方，不管有多少层级，分类发生了什么翻天覆地的变化，下一次更新就能展示。\n5. seo友好  ---通过golang直接将 markdown 渲染成 html展示\n\n## 更新日志\n### V3.1\n* pan-jf 提供了很赞的tag功能 👍🏻。\n* 去掉标题的.MD后缀\n* 添加文档图片移动到网站根目录images下，本地写文章时可以使用 ```![demo](./images/demo.jpg)```连接图片，线上自动连接。\n\n### V3.0\n* 完全重构，添加了短链，美化了 URL \n* 自动完成克隆工作\n* 添加了网易云音乐功能\n* 文件自动生成导航（导航排序通过时间可自定义）\n\n### V2.0\n* 文章可以配置一些关键信息，可排序\n* 添加仪表盘\n* 添加文章评论\n* 支持切换主题\n* 移动端更好的适配\n* 添加webHook支持\n\n### V1.0\n* 基础功能，手动克隆并定时更新文章\n\n\n##  感谢\n\nA special thank you to JetBrains for donating licenses to us!\n\nPlease click the logo to let them know your appreciation!\n\n\u003ca href=\"https://www.jetbrains.com/?from=ForestBlog\"\u003e\u003cimg src=\"resources/images/jetbrains.png\" width=\"100\" alt=\"JetBrains\"/\u003e\u003c/a\u003e\n\n## License\n\nMIT © Richard McRichface\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxusenlin%2Fforest-blog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxusenlin%2Fforest-blog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxusenlin%2Fforest-blog/lists"}