📝

Open Notebook

A minimalist, high-performance personal knowledge base powered by Next.js.

"Manage your notes like code, publish them like professional documentation."

license stars last commit
⭐ Star on GitHub 🚀 Deploy with Vercel
🚀

Quick Start

Up and running in 60s
✨

Features

See what's possible
🚢

Deploy Guide

One-click deployment

✨ Why Open Notebook?

While tools like Notion are powerful, they often feel heavy and "lock" your data. Open Notebook is designed for developers who want a private, version-controlled, and lightning-fast alternative.

⚡️ Instant Loading

Built on Next.js & React for near-zero latency.

✍️ Dev-Centric Workflow

Write in Markdown, manage with Git, deploy via GitHub Actions.

🔍 Full-Text Search

Find what you need in milliseconds with built-in local search.

📱 Pure Reading Experience

Clean, distraction-free UI on mobile, tablet, and desktop.

🛡️ Own Your Data

No proprietary formats. Your knowledge stays in your repo forever.

🚀 Zero Cost

Host for free on GitHub Pages, Vercel, or Netlify.

📊 How does it compare?

Feature Open Notebook Notion Obsidian
No account required ✓ ✗ ✓
Notes as code (Git) ✓ ✗ ✓
Free hosting ✓ ✗ ✗
Vue components ✓ ✗ ✗
100% data ownership ✓ ✗ ✓
SEO-friendly publish ✓ ✓ ✗

🖥️ CLI Tool (Bonus)

A lightweight command-line tool for academic research, powered by Gemini API and OpenAlex.

📚 Paper Search

Search academic papers via OpenAlex, sorted by citations.

📥 PDF Download

One-click download from arXiv and open sources.

🤖 AI Q&A

Chat with Gemini AI about your papers.

📊 Data Export

Export QA pairs as JSONL for model fine-tuning.

# Install via pip
pip install "git+https://github.com/hongping-zh/open-notebook.git"

# Search papers
acm search "transformer attention"

# AI chat
acm chat ask "What is the main contribution?"
🔧 View Detailed Installation Guide

🚀 Quick Start

Get your notebook up and running in less than 60 seconds.

1. Clone the Template

git clone https://github.com/hongping-zh/open-notebook.git
cd open-notebook/frontend

2. Install Dependencies

npm install # or pnpm install / yarn

3. Start Writing

npm run dev

Visit http://localhost:3000 to see your notes live!

🚢 One-Click Deployment

This project comes with a pre-configured GitHub Action.

  1. Push your changes to GitHub.
  2. Enable GitHub Pages in your repository settings (set to GitHub Actions source).
  3. Your site is live! 🌍

📂 Project Structure

. ├── docs/ # Your Markdown files live here │ ├── index.md # The homepage │ └── guide/ # Categorized notes ├── .vitepress/ # Configuration (Nav, Sidebar, Themes) └── package.json

🤝 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch
  3. Commit your Changes
  4. Push to the Branch
  5. Open a Pull Request