https://github.com/amadeusssystem/inkporter
Inkporter is an Obsidian plugin that digitizes handwritten notes with smart ink isolation, adaptive theming, and seamless import workflows.
https://github.com/amadeusssystem/inkporter
obsidian obsidian-community obsidian-notes obsidian-plugin
Last synced: 23 days ago
JSON representation
Inkporter is an Obsidian plugin that digitizes handwritten notes with smart ink isolation, adaptive theming, and seamless import workflows.
- Host: GitHub
- URL: https://github.com/amadeusssystem/inkporter
- Owner: AmadeussSystem
- License: mit
- Created: 2025-01-27T13:05:33.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2025-04-01T05:41:47.000Z (about 1 month ago)
- Last Synced: 2025-04-01T06:28:58.938Z (about 1 month ago)
- Topics: obsidian, obsidian-community, obsidian-notes, obsidian-plugin
- Language: TypeScript
- Homepage:
- Size: 30.4 MB
- Stars: 16
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Inkporter 📝➡️📓
**Seamlessly digitize handwritten notes into Obsidian with smart ink isolation and adaptive theming**
---
## Why Inkporter?
Tired of manually processing notebook scans? This plugin automates the workflow from this while adding powerful Obsidian integration: Please Watch this video to understand the motivation behind the plugin. Go Sub this Guy his works really somethink to see
![BEST of BOTH Worlds? Digitizing Field Notes inside Obsidian [Showcase]](https://img.youtube.com/vi/9T9VL8_i1Tg/maxresdefault.jpg)
| Manual Process | Inkporter Automation |
|-------------------------|------------------------------|
| 20min/page in Photoshop | Instant clipboard processing |
| Manual CSS theming | Auto-adaptive ink colors |
| Static file naming | Smart filename templates |
---
## 🚀 Installation
### Via Obsidian
1. **Settings** → **Community plugins** → **Browse**
2. Search "Inkporter" → Install
### Manual
1. Download the latest release.
2. Copy to `vault/.obsidian/plugins`.
---
## 🔧 Key Features
### ✂️ Intelligent Ink Isolation
- Real-time preview of processed images
- Dual threshold modes:
- **Luminosity mode** (perceptual brightness)
- **Simple RGB average**
- Grayscale conversion option
### 🌈 Dynamic Theming
```css
/* Apply to note CSS classes */
.inkporter-scan { /* class already exists just use it in cssclasses */
--ink-color: var(--text-normal);
--paper-color: var(--background-primary);
filter: contrast(120%);
}
```
### 📂 Smart Asset Management
```yaml
# File naming templates
filename_template: "note-{date}-{shortId}"
# Supported variables:
# - {date}: YYYYMMDD
# - {timestamp}: epoch ms
# - {shortId}: 8char hash
# - {uuid}: v4 UUID
```
---
## 📎 Usage Workflow
1. **Scan** → Import via clipboard (`Ctrl/Cmd+Shift+V) // Need to manually Keybind this.
2. **Preview** → Adjust settings in real-time
3. **Insert** → Automatically saved to vault
4. **Style** → Apply CSS classes for theming
---
## ⚙️ Configuration
```javascript
// Settings structure
{
outputDirectory: "InkporterScans", // Save location
alphaThreshold: 180, // 0-255 darkness cutoff
fileNameTemplate: "note-{date}-{shortId}",
convertToGrayscale: false, // B/W conversion
useLuminosityForAlpha: true // Perceptual vs simple
}
```
---
## 🌐 Compatibility
| Environment | Support |
|--------------|------------------|
| Obsidian | v1.4+ |
| OS | Win/Mac/Linux |
| Mobile | iOS/Android* |
| Scanners | Any clipboard |
---
**Optimal Results When:**
- 📜 Using **light-colored paper** (white/cream)
- ✍️ Writing with **high-contrast ink** (black/dark blue)
- 💡 Scanning in **bright, even lighting**
*Why?* The alpha threshold detection works best with clear light/dark separation. We're working on:
- Dark background support 🎨
- Multi-ink color detection 🔍
- Adaptive lighting compensation 💡
[Follow development progress →](milestones.md)
---
## 🤝 Contributing
Help improve:
- Mobile scanning UX
- Multi-ink detection
- Batch processing
See our [contribution guidelines](CONTRIBUTING.md).
---
## 📜 License
MIT License - See [LICENSE](LICENSE).
---
## 💡 Why This Name?
**Inkporter** combines:
- **Ink** (handwritten notes)
- **Port** (transfer/carry)
- **-er** (active tool suffix)
Represents "carrying ink into digital" while sounding like a professional tool.
---
## 🛣️ Support
Found a bug? Have feature ideas?
📧 [My Email](mailto:[email protected])
🔍 [GitHub Issues](https://github.com/AmadeussSystem/inkporter/issues)
💬 [Discord ID](https://discordapp.com/users/1100777573002264637)
---
> **From the Developer**
> "This plugin was born from 47 hours spent cleaning up scans of my Moleskine notebooks. What started as a simple threshold script became an obsession with perfectly bridging analog and digital note-taking. May your handwritten wisdom live forever in both paper and pixels!" - Ayush