Skip to content

About

Python-Powered Markdown to OneNote Converter

Resources

Stars

9 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

10 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎨 Markdown to OneNote Converter

GitHub Pages License: MIT JavaScript CSS3 HTML5

✨ Transform your Markdown content into beautiful OneNote-compatible format with advanced diagram support and modern styling

πŸš€ Live Demo

Try it now on GitHub Pages!

🌟 Features

πŸ“ Core Functionality

  • Real-time Markdown Conversion - See your content transform as you type
  • OneNote Optimization - Specially formatted for seamless OneNote integration
  • Dual Output Modes - Choose between OneNote-compatible PNG diagrams or web-friendly SVG
  • File Upload Support - Load .md and .txt files directly
  • Export Options - Copy to clipboard or download as HTML

🎨 Diagram Support

  • πŸ§œβ€β™€οΈ Mermaid Diagrams - Flowcharts, sequence diagrams, and more
  • 🌿 PlantUML Diagrams - UML diagrams with full PlantUML syntax support
  • πŸ“Š GraphViz Diagrams - Powerful graph visualization with DOT notation
  • PNG/SVG Export - Automatic conversion for OneNote compatibility

🎨 Modern UI/UX

  • Dark Theme Design - Easy on the eyes with GitHub-inspired styling
  • Responsive Layout - Perfect on desktop, tablet, and mobile
  • Glass Morphism Effects - Modern backdrop blur and transparency
  • Smooth Animations - Subtle transitions and hover effects
  • Custom Scrollbars - Styled scrollbars for consistent experience

πŸ› οΈ Technologies Used

Frontend Stack

  • Vanilla JavaScript (ES6+) - Modern JavaScript with async/await
  • CSS3 with Custom Properties - Advanced styling with CSS variables
  • HTML5 - Semantic markup with accessibility features

Libraries & Dependencies

Design Features

  • Google Fonts - Inter & JetBrains Mono for optimal readability
  • CSS Grid & Flexbox - Modern layout systems
  • CSS Gradients - Beautiful color transitions
  • CSS Animations - Smooth micro-interactions
  • Responsive Design - Mobile-first approach

🎯 Use Cases

πŸ“š Documentation

  • Convert technical documentation to OneNote
  • Preserve code syntax highlighting
  • Include flowcharts and diagrams

πŸ“Š Project Planning

  • Transform project plans with Gantt charts
  • Convert user story mapping to OneNote
  • Include architecture diagrams

πŸŽ“ Education

  • Convert course notes with mathematical notation
  • Include concept maps and mind maps
  • Transform study guides with visual elements

πŸ’Ό Business

  • Convert meeting notes with action items
  • Include process flow diagrams
  • Transform project proposals with charts

πŸš€ Getting Started

Option 1: Use Online (Recommended)

  1. Visit https://allarddewinter.github.io/markdown-to-onenote/
  2. Paste your Markdown content
  3. Select output mode (OneNote or HTML)
  4. Copy the result to your clipboard
  5. Paste directly into OneNote

Option 2: Local Development

# Clone the repository
git clone https://github.com/allarddewinter/markdown-to-onenote.git

# Navigate to the project directory
cd markdown-to-onenote

# Open with a local server (recommended)
# Using Python 3
python -m http.server 8000

# Using Node.js (if you have http-server installed)
npx http-server

# Or simply open index.html in your browser

πŸ“– Usage Examples

Basic Markdown

# My Project Documentation

## Overview
This is a **sample** project with _italic_ text and `inline code`.

### Features
- Feature 1
- Feature 2
- Feature 3

Mermaid Diagrams

```mermaid
graph TD
    A[Start] --> B{Is it working?}
    B -->|Yes| C[Great!]
    B -->|No| D[Debug]
    D --> B
```

PlantUML Diagrams

```plantuml
@startuml
actor User
User -> System: Login Request
System -> Database: Validate User
Database -> System: User Valid
System -> User: Login Success
@enduml
```

GraphViz Diagrams

```graphviz
digraph G {
    rankdir=LR;
    node [shape=box];
    A -> B -> C;
    A -> D -> C;
}
```

βš™οΈ Configuration

Output Modes

OneNote Mode (Default)

  • Converts diagrams to PNG images
  • Optimized for OneNote compatibility
  • Best for final documentation

HTML Mode

  • Keeps diagrams as SVG
  • Better for web viewing
  • Smaller file sizes

Diagram Rendering

The application automatically detects and renders:

  • Mermaid: ```mermaid code blocks
  • PlantUML: ```plantuml code blocks
  • GraphViz: ```graphviz or ```dot code blocks

🎨 Styling Features

CSS Custom Properties

The application uses CSS variables for easy customization:

:root {
    --bg-primary: #0d1117;
    --text-primary: #f0f6fc;
    --border-accent: #58a6ff;
    /* ... and many more */
}

Responsive Breakpoints

  • Desktop: 1200px and above
  • Tablet: 768px - 1199px
  • Mobile: Below 768px

πŸ”§ Browser Compatibility

Browser Version Status
Chrome 80+ βœ… Full Support
Firefox 75+ βœ… Full Support
Safari 13+ βœ… Full Support
Edge 80+ βœ… Full Support

Required APIs

  • Clipboard API - For copy functionality
  • Canvas API - For diagram PNG conversion
  • WebAssembly - For GraphViz rendering

🀝 Contributing

Contributions are welcome! Here's how you can help:

πŸ› Bug Reports

  • Use the issue tracker
  • Include browser version and steps to reproduce
  • Provide sample Markdown that causes issues

πŸ’‘ Feature Requests

  • Check existing issues first
  • Describe the use case and expected behavior
  • Consider contributing a pull request

πŸ”§ Development

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature-name
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

πŸ“ Code Style

  • Use ES6+ features
  • Follow existing naming conventions
  • Add comments for complex logic
  • Test with multiple browsers

πŸ“š API Reference

MarkdownToOneNoteConverter Class

Constructor

const converter = new MarkdownToOneNoteConverter();

Methods

  • convertMarkdown() - Convert current input to HTML
  • clearContent() - Clear input and output
  • copyToClipboard() - Copy result to clipboard
  • downloadHTML() - Download result as HTML file
  • loadFile(event) - Load file from input

Diagram Processors

  • processMermaidDiagrams(markdown) - Process Mermaid diagrams
  • processPlantUMLDiagrams(markdown) - Process PlantUML diagrams
  • processGraphVizDiagrams(markdown) - Process GraphViz diagrams

🎯 Roadmap

πŸ”„ Version 2.0 (Planned)

  • Math Equation Support - LaTeX/MathJax integration
  • Custom CSS Themes - User-defined styling
  • Batch File Processing - Multiple file conversion
  • Advanced Export Options - PDF, Word, etc.

πŸ“„ License

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

πŸ™ Acknowledgments

πŸ“ž Support


Made with ❀️ by Allard de Winter

⭐ Found this helpful? Give it a star! ⭐

About

Python-Powered Markdown to OneNote Converter

Resources

Stars

9 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages