星光-黑曜石：将Obsidian vaults发布到Starlight网站的最佳实践

星光-黑曜石：将Obsidian vaults发布到Starlight网站的最佳实践

starlight-obsidian Starlight plugin to publish Obsidian vaults 项目地址: https://gitcode.com/gh_mirrors/st/starlight-obsidian

1. 项目介绍

星光-黑曜石（Starlight Obsidian）是一个开源插件，它允许用户将他们的Obsidian vaults轻松发布到Starlight网站上。Starlight是一个静态网站生成器，Obsidian则是一个强大的知识库应用。通过这个插件，用户可以自动化地将他们的笔记和知识库转换成精美的网页。

2. 项目快速启动

要开始使用星光-黑曜石插件，请遵循以下步骤：

首先，确保你已经安装了Node.js和npm。

# 克隆项目到本地
git clone https://github.com/HiDeoo/starlight-obsidian.git

# 进入项目目录
cd starlight-obsidian

# 安装依赖
npm install

# 构建项目
npm run build

# 本地启动Starlight服务器
npm start

以上命令将会构建你的Obsidian vault，并在本地启动一个Starlight服务器，你可以在浏览器中访问 http://localhost:3000 来查看结果。

3. 应用案例和最佳实践

案例一：自动化发布流程

为了自动化发布流程，你可以使用GitHub Actions来在每次提交代码时自动构建和部署你的网站。

1. 在你的仓库中创建一个新的GitHub Actions工作流文件（例如 .github/workflows/deploy.yml）。
2. 添加以下内容到你的工作流文件中：

name: Deploy

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Install Dependencies
      run: npm install
    - name: Build
      run: npm run build
    - name: Deploy
      uses: vercel/vercel-action@v3
      with:
        token: ${{ secrets.VERCEL_TOKEN }}
        production: true

确保你已经设置了Vercel的token作为仓库的秘密，以便工作流可以使用它来部署网站。

案例二：定制主题和样式

星光-黑曜石支持自定义主题和样式。你可以通过修改 src/theme.css 文件来定制网站的外观。

/* 定制主题颜色 */
:root {
  --primary-color: #6466f1;
}

/* 定制文字样式 */
body {
  font-family: 'Arial', sans-serif;
}

4. 典型生态项目

星光-黑曜石的生态系统包括多个相关的项目和插件，以下是一些典型的生态项目：

• Starlight CLI: 用于命令行操作的Starlight工具，可以用来快速启动和构建项目。
• Starlight Theme: 一系列可用的主题，可以让你轻松改变网站的外观。
• Starlight Plugins: 各种插件，增加了星光-黑曜石的功能，比如搜索、 analytics等。

通过使用星光-黑曜石及其生态项目，你可以构建出功能丰富且个性化的静态网站。

starlight-obsidian Starlight plugin to publish Obsidian vaults 项目地址: https://gitcode.com/gh_mirrors/st/starlight-obsidian