项目简介
本项目是面向开发者群体,为学习而打造的博客分享平台。它能为用户提供文章浏览、评论、搜索等服务,旨在带来简洁、高效且美观的博客分享体验,同时支持文章高亮显示和搜索功能。
项目的主要特性和功能
已实现功能
- 搜索:采用Algolia方案,构建时生成文章的json/js文件用于搜索,可快速定位文章。
- 代码美化与高亮:对代码进行苹果窗口美化并增加行数,同时实现代码高亮,提升阅读体验。
- 评论系统:集成waline评论系统,支持用户对文章评论互动,有最近评论展示。
- 回到顶部:方便用户浏览长文章时快速回到页面顶部。
- Toc组件:参考react文档实现,便于文章内容导航。
- 相关文章:展示与当前文章相关的其他文章。
- 点赞功能:用户可对文章进行点赞。
- 文章信息:文章包含标题、简述、浏览数等信息。
待实现功能
- MDX支持:支持Markdown和JSX混合的博客内容,实现更丰富的文章展示形式。
- 归档、文章分类、分页:方便文章的整理和浏览。
- 个人收藏网站模块、个人网站:满足用户个性化需求。
- 评论通知:及时告知用户评论相关信息。
- 在线编辑发布,组件可视化添加:提升用户发布文章的便捷性。
可选功能/后期添加
- 多窗口:实现多窗口浏览功能。
- 代码一键复制:方便用户复制代码。
- 懒加载:优化页面加载性能。
文章信息完善
文章(发布/更新)时间自动添加更新,完善评论数和图片展示,支持文章置顶。
非功能需求
进行SEO优化,优化写博客流程以提升效率。
代码、工程方面
使用husky+commitlint进行代码提交规范管理,开展自动化测试。
安装使用步骤
- 假设用户已下载本项目的源码文件。
- 在项目根目录下创建并配置
.env
文件,设置相关环境变量(如API密钥等)。 - 打开终端,在项目根目录下运行命令安装依赖项,可使用
npm install
或者yarn install
。 - 安装完成后,运行开发服务器,命令为
npm run dev
或者yarn dev
。 - 根据自身需求对项目配置和样式进行调整。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】