Skip to content

janaSunrise/mathsidian

Repository files navigation

Mathsidian

Mathsidian fixes Obsidian's bottlenecks by providing tools for scientific and mathematical note-taking.

Create stunning graphs, annotate images, and build precise scientific diagrams that integrate seamlessly with your Obsidian workflow.

Features

  • 📊 Interactive Graph Plotter (Available)
  • 🖼️ Image Annotator (Coming Soon)
  • 📐 Diagram Creator (Coming Soon)
  • Formula Library (Coming Soon)

Tech Stack

  • Frontend: Next.js 15 with TypeScript
  • Styling: Tailwind CSS + Radix UI
  • Visualization: D3.js + Konva.js
  • Math: KaTeX for LaTeX rendering

Getting Started

Prerequisites

  • Node.js 18+
  • Bun (recommended) or npm/yarn/pnpm

Installation

  1. Clone the repository

    git clone https://github.com/janaSunrise/mathsidian.git
    cd mathsidian
  2. Install dependencies

    bun install
  3. Run the development server

    bun dev
  4. Open your browser Navigate to http://localhost:3000

Alternative Package Managers

# Using npm
npm install && npm run dev

# Using yarn
yarn install && yarn dev

# Using pnpm
pnpm install && pnpm dev

Development Scripts

# Development server with Turbopack
bun dev

# Production build
bun run build

# Start production server
bun start

# Lint code
bun run lint

# Format code with Prettier
bun run format

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

Support the Project

If you find Mathsidian helpful, consider supporting it:

Buy Me A Coffee

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published