Skip to content

hixyl/YlBlog

Repository files navigation

玉龙博客框架

本框架是类似hexo的前端框架,同时支持后端ssr技术,即服务端加载技术,示例页面: https://www.timeshike.com

功能介绍

  1. 本博客支持静态部署,以及服务端动态渲染,基于next.js框架。
  2. 已支持生成sitemap和rss订阅,做好了SEO优化。
  3. 所有文章内容可以用markdown书写,支持配图和代码块复制。
  4. 支持搜索文章,纯前端实现,速度快。
  5. 基于React,高度自定义,欢迎大家基于玉龙博客框架进行二次开发。

开始使用

项目的运行

将项目clone到本地之后,在项目目录运行

npm install
npm run dev

yarn install
yarn dev

打开 http://localhost:3000 即可进行开发

项目功能使用指南

所有的页面位于app/下,app/下的目录即为路由。

将文章的md文件放在articles/目录下即可,模板已经放置在项目中。如果有图片,请放在public/article/[文章文件名(不含扩展名)], 具体使用方法可以参考项目中的示例。

网站的侧边栏位于 components/Sidebar/下,可以自定义。

导航栏配置项在config/目录下,可以参考模板自定义导航栏的图标,导航栏图标可以下载下来放到public/目录下即可。

项目的部署方法

运行 npm run build 即可输出静态文件,如果使用github pages,将out/文件夹内容上传到项目中即可完成静态部署。

了解更多

了解更多关于Next.js的内容:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

About

YuLong Blog - A front-end blogging framework powered by Next.js. (玉龙博客-由Next.js驱动的前端博客框架)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published