https://github.com/tachibanayu24/_old_obsidian-blog
https://github.com/tachibanayu24/_old_obsidian-blog
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/tachibanayu24/_old_obsidian-blog
- Owner: tachibanayu24
- Created: 2025-03-22T12:49:41.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-24T17:28:13.000Z (about 2 months ago)
- Last Synced: 2025-04-03T22:19:42.867Z (about 1 month ago)
- Language: TypeScript
- Size: 252 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Hokori note
Obsidian のノートをブログとして公開するための Web アプリケーションです。
## 概要
このプロジェクトは、Obsidian の特定ディレクトリ下のノートをブログとして公開するためのシンプルなアプリケーションです。Markdown 形式で書かれたノートを美しく表示し、タグによる整理や検索機能を提供します。
## 機能
- 📝 Obsidian ノートのブログ形式での表示
- 🔍 タグとタイトルによる検索
- 🌙 ダークテーマのみのシンプルな UI
- 📱 レスポンシブデザイン
- 🔗 ノート間のリンク対応
## 技術スタック
- React + React Router 7
- Tailwind CSS
- TypeScript
## 開発環境
### 必要条件
- Node.js 18 以上
- npm または yarn
### インストール
```bash
npm install
```
### 開発サーバーの起動
```bash
npm run dev
```
アプリケーションは `http://localhost:5173` で利用できます。
### コードフォーマット
このプロジェクトではコードの一貫性を保つために Prettier を使用しています。
```bash
# すべてのファイルをフォーマット
npm run format
# フォーマットチェックのみ実行
npm run format:check
```
#### エディタ設定
VSCode を使用している場合は、以下の拡張機能をインストールすることをお勧めします：
- [Prettier - Code formatter](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
`.vscode/settings.json` で保存時に自動フォーマットが有効になっています。
### ビルド
```bash
npm run build
```
## Obsidian の設定
- `_published/` ディレクトリ以下のノートが公開対象となります
- 添付ファイルは `_config/attachment` に保存してください
- 各ノートには以下のプロパティを設定してください:
- aliases: slug（URL）として使用されます
- tags: ブログのタグとなります
- create_date: 作成日 (YYYY-MM-DD)
- update_date: 更新日 (YYYY-MM-DD)
- uid: ユニーク ID
- published: true の場合のみ公開されます
---
© 2024 Hokori note