首页 / 使用文档

Friday 使用文档

欢迎使用 Friday 完整使用文档，这是一个将您的笔记转换为精美网站的 Obsidian 插件。

快速开始

安装插件

  1. 打开 Obsidian 社区插件
  2. 搜索 Friday 并安装
  3. 启用插件
  4. Friday 面板将出现在您的侧边栏中

快速上手

  1. 从 MDFriday 面板中选择主题
  2. 下载主题的示例笔记
  3. 右键点击笔记 → 发布到网络
  4. 点击预览在本地实时查看

预览后，用您自己的内容编辑示例笔记 — 您就拥有了个人网站！

Friday 工作原理

Friday 遵循简单的 4 步流程：

  1. 写作 - 在 Obsidian 中使用 Markdown 创建内容
  2. 选择 - 从 500+ 专业主题中选择
  3. 预览 - 编辑时查看即时本地预览（所见即所得）
  4. 发布 - 一键部署或导出静态文件

核心功能

📝 灵活发布

  • 单个笔记 - 即时发布单个页面
  • 整个文件夹 - 发布完整的网站结构
  • 选择性发布 - 精确选择要分享的内容
  • 批量操作 - 一次处理多个文件

🚀 闪电般快速的本地预览

  • 即时构建 - 无需等待，无需上传
  • 实时更新 - 编辑时立即看到变化
  • 所见即所得体验 - 您看到的就是您得到的
  • 本地处理 - 所有操作都在您的机器上进行

🎨 500+ 精美主题

为各种用途选择专业设计的主题：

☁️ 多种部署选项

  • Netlify - 一键部署到 Netlify
  • FTP 上传 - 通过 FTP 自定义托管
  • 本地导出 - 导出完整的静态网站文件
  • GitHub Pages - 通过 GitHub 集成部署（即将推出）

详细工作流程

1. 安装和设置

1. 从社区插件安装 Friday
2. 在侧边栏打开 Friday 面板
3. 浏览可用主题
4. 下载所选主题的示例内容

2. 自定义内容

1. 用您的内容编辑下载的示例笔记
2. 添加您自己的图片、文本和结构
3. 正常使用 Obsidian 的 Markdown 功能
4. 根据需要在文件夹中组织文件

3. 本地预览

1. 右键点击任何笔记 → "发布到网络"
2. 点击"预览"按钮
3. Friday 即时构建您的网站
4. 浏览器打开显示您的实时网站
5. 编辑文件并实时查看变化

4. 在线部署

选项 A - Netlify：
1. 点击"部署到 Netlify"
2. 使用您的 Netlify 账户授权
3. 您的网站立即上线

选项 B - 导出文件：
1. 点击"导出网站"
2. 选择目标文件夹
3. 将文件上传到任何网络主机

选项 C - FTP 上传：
1. 配置 FTP 设置
2. 点击"通过 FTP 上传"
3. 文件同步到您的服务器

主题分类

文档网站

非常适合项目文档、API 参考、用户指南：

  • 简洁、专业的布局
  • 导航侧边栏
  • 搜索功能
  • 代码语法高亮

博客和个人网站

适合个人博客、作品集、日记：

  • 带日期的文章布局
  • 标签和分类支持
  • 社交媒体集成
  • 评论系统

商业和着陆页

适用于公司、产品、服务：

  • 英雄区块和行动号召
  • 功能展示
  • 联系表单
  • SEO 优化

作品集和简历网站

展示您的工作和经验：

  • 项目画廊
  • 时间轴布局
  • 技能展示
  • PDF 下载链接

高级功能

Frontmatter 支持

Friday 识别标准的 frontmatter 字段：

---
title: "我的页面标题"
date: 2023-10-15
tags: [网络, 设计]
featured_image: "hero.jpg"
description: "用于 SEO 的页面描述"
---

多语言网站

创建国际化网站：

content/
├── en/
│   ├── about.md
│   └── blog/
└── zh/
    ├── about.md
    └── blog/

自定义样式

使用以下方式覆盖主题样式：

  • 自定义 CSS 文件
  • 主题配置文件
  • Sass/SCSS 支持（取决于主题）

部署选项详解

Netlify 部署

  • 优点：免费托管、自动 SSL、表单处理
  • 最适合：个人网站、小型项目
  • 设置：一键授权

FTP 上传

  • 优点：使用现有托管、完全控制
  • 最适合：商业网站、自定义域名
  • 设置：一次性配置 FTP 凭据

本地导出

  • 优点：最大灵活性、任何托管提供商
  • 最适合：高级用户、自定义设置
  • 设置：选择导出位置，手动上传

故障排除

常见问题

预览无法工作？

  • 检查端口 8090 是否可用
  • 如需要可重启 Obsidian
  • 验证主题文件是否完整

图片无法显示？

  • 使用相对于笔记位置的路径
  • 将图片放在同一文件夹或子文件夹中
  • 检查图片文件扩展名是否受支持

主题无法加载？

  • 确保主题文件在正确位置
  • 检查主题与 Friday 版本的兼容性
  • 尝试重新下载主题

部署失败？

  • 验证网络连接
  • 检查部署服务凭据
  • 查看控制台中的错误消息

获取帮助

开发者信息

Friday 构建技术：

  • TypeScript - 完整类型安全
  • Hugo 引擎 - 世界上最快的静态网站生成器（重写版）
  • React - 现代 UI 组件
  • Obsidian API - 与 Obsidian 深度集成

贡献

我们欢迎贡献！查看我们的 GitHub 仓库 了解：

  • 源代码
  • 问题跟踪
  • 功能请求
  • 开发设置

许可证

Friday 是免费开源软件，根据 MIT 许可证发布。详情请参阅 LICENSE 文件。

需要更多帮助？