Jade is an open-source publishing solution for Obsidian, allowing you to turn your Obsidian vault into an online website easily. With full support for Obsidian-flavored Markdown and wiki-style internal links, Jade offers a seamless experience for publishing and browsing your notes online.

• Obsidian-Flavored Markdown: Supports Obsidian's extended Markdown syntax, including callouts, footnotes, comments, and embedded content.
• Wiki-Style Internal Links: Enables seamless navigation using [[WikiLinks]], just like in Obsidian.
• Responsive Layout: Optimized for desktop and mobile devices with a fully responsive design.
• Built-in Search: Allows users to quickly find content within the published site.

For more details about features, please read the documentation: https://jade.lucasji.cn

Before installing Jade, ensure you have the following:

1. Obsidian installed on your device.
2. The Jade Publisher plugin installed in Obsidian to facilitate note publish.

1. Install Node.js(v22 or higher)

2. Install and run Redis Stack Server

   docker run -d --name redis-stack-server -p 6379:6379 -v /root/data/redis/:/data -e REDIS_ARGS="--requirepass ${REDIS_PASS}" redis/redis-stack-server:latest

3. Clone the Repository

   git clone [email protected]:LucasJi/Jade.git
   cd Jade

4. Install Dependencies

   pnpm install

5. Create .env file

   cp .env.example .env

6. Edit .env to config required environment variables

   • NEXT_PUBLIC_BASE_URL: The base url of your Jade service
   • ACCESS_TOKEN: Used to protect synchronize related APIs
   • REDIS_HOST: Redis stack server host
   • REDIS_PORT: Redis stack server port
   • REDIS_PASS: Redis stack server password

7. Build & Run(make sure redis stack server is running)

   pnpm run build
   pnpm start

1. Run your Jade service
2. Config the Jade Publisher plugin in your Obsidian vault
3. Synchronize your vault to Jade service
4. Visit NEXT_PUBLIC_BASE_URL to view your vault online

We welcome contributions! Feel free to submit issues, feature requests, or pull requests on GitHub.