Obsidian Share

A powerful tool designed to seamlessly share your Obsidian notes with colleagues and friends through secure, unique URLs.

Features

• Multiple Export Formats: Download shared notes as PDF, HTML, or MD
• URL Management: Generate shortened URLs for easy sharing
• Security: Password protection for sensitive documents
• File Control: Delete shared URLs when no longer needed
• Cost-Effective: 100% free and open source
• One-Click Sharing: Streamlined sharing process

Project Structure

obsidian-share/
├── public/
│   ├── assets/
│   │   ├── icons/
│   │   └── styles/
│   └── index.html
├── src/
│   ├── components/
│   │   ├── FileUpload.ts
│   │   ├── URLGenerator.ts
│   │   ├── PasswordProtect.ts
│   │   └── FileConverter.ts
│   ├── services/
│   │   ├── urlService.ts
│   │   ├── fileService.ts
│   │   └── authService.ts
│   ├── utils/
│   │   ├── fileConverter.ts
│   │   └── urlShortener.ts
│   └── App.ts
├── config/
│   ├── vite.config.ts
│   └── tsconfig.json
├── tests/
│   └── unit/
└── package.json

Quick Start Guide

Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• Modern web browser

Installation

git clone https://github.com/anonymousknight07/Obsidian-share.git
cd obsidian-share
npm install

Development

npm run dev

Production Build

npm run build

How to Use

1. File Upload

• Navigate to the web interface
• Click "Upload File" or drag and drop your Obsidian note
• Supported formats: .md, .markdown, .txt

2. URL Generation

• After upload, click "Generate URL"
• Choose URL type:
  • Standard URL
  • Short URL (recommended for sharing)

3. Share URL

• Copy the generated URL using the "Copy" button
• Share via email, messaging apps, or any communication platform
• Recipients can access the note through their web browser

4. Security Options

• Enable password protection:
  1. Click "Protect File"
  2. Set a strong password
  3. Share the password separately with intended recipients

5. File Download Options

Recipients can download the shared file in multiple formats:

• PDF: Best for printing and offline reading
• HTML: Web-friendly format
• MD: Edit in VS Code, Obsidian, or other markdown editors

Security Considerations

• All files are encrypted in transit
• URLs expire after 30 days of inactivity
• No sensitive data is stored on servers

Technical Stack

• Frontend: Vue.js + TypeScript
• Backend: Node.js + Express
• Database: PostgreSQL
• File Storage: S3-compatible storage
• URL Shortener: Custom implementation

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

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

Support

• GitHub Issues: For bug reports and feature requests
• Email Support: akshath0703@gmail.com