mirror of
https://github.com/amitwh/markdown-converter.git
synced 2026-10-01 17:29:29 +05:30
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
 amitwh
|
42ad314302 |
@@ -1,28 +0,0 @@
|
|||||||
name: CI
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches: [master]
|
|
||||||
pull_request:
|
|
||||||
branches: [master]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 20
|
|
||||||
cache: npm
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Run tests
|
|
||||||
run: npm test
|
|
||||||
|
|
||||||
- name: Run linter
|
|
||||||
run: npm run lint
|
|
||||||
@@ -1,178 +0,0 @@
|
|||||||
name: Release
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags: ['v*']
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-linux:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 20
|
|
||||||
cache: npm
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Download external tools (pandoc)
|
|
||||||
run: node scripts/download-tools.js
|
|
||||||
|
|
||||||
- name: Bundle MarkItDown (optional, best effort)
|
|
||||||
# Freezes markitdown + Python into bin/linux/markitdown; failure is
|
|
||||||
# non-fatal — the build then ships without it and the app falls back
|
|
||||||
# to a system markitdown at runtime.
|
|
||||||
run: npm run bundle:markitdown
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- name: Run tests
|
|
||||||
run: npm test
|
|
||||||
|
|
||||||
- name: Build Linux packages
|
|
||||||
run: npm run build:linux-ci -- --publish=never
|
|
||||||
|
|
||||||
- name: Upload Linux artifacts
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: linux-artifacts
|
|
||||||
path: |
|
|
||||||
dist/*.deb
|
|
||||||
dist/*.AppImage
|
|
||||||
dist/*.snap
|
|
||||||
dist/*.rpm
|
|
||||||
retention-days: 5
|
|
||||||
|
|
||||||
build-windows:
|
|
||||||
runs-on: windows-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 20
|
|
||||||
cache: npm
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Download external tools (pandoc)
|
|
||||||
run: node scripts/download-tools.js
|
|
||||||
|
|
||||||
- name: Bundle MarkItDown (optional, best effort)
|
|
||||||
# Windows runners ship python + venv; non-fatal on failure — the
|
|
||||||
# package then omits the bundled binary by design
|
|
||||||
run: npm run bundle:markitdown
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- name: Run tests
|
|
||||||
run: npm test
|
|
||||||
|
|
||||||
- name: Decode certificate (if available)
|
|
||||||
if: ${{ env.CSC_LINK_BASE64 != '' }}
|
|
||||||
shell: pwsh
|
|
||||||
env:
|
|
||||||
CSC_LINK_BASE64: ${{ secrets.CSC_LINK_BASE64 }}
|
|
||||||
run: |
|
|
||||||
$bytes = [Convert]::FromBase64String("$env:CSC_LINK_BASE64")
|
|
||||||
[IO.File]::WriteAllBytes("${{ github.workspace }}\code-signing-cert.pfx", $bytes)
|
|
||||||
echo "CERT_AVAILABLE=true" >> $env:GITHUB_ENV
|
|
||||||
|
|
||||||
- name: Build Windows packages (signed)
|
|
||||||
if: ${{ env.CERT_AVAILABLE == 'true' }}
|
|
||||||
env:
|
|
||||||
CSC_LINK: code-signing-cert.pfx
|
|
||||||
CSC_KEY_PASSWORD: ${{ secrets.CSC_KEY_PASSWORD }}
|
|
||||||
run: npm run build:win-signed -- --publish=never
|
|
||||||
|
|
||||||
- name: Build Windows packages (unsigned)
|
|
||||||
if: ${{ env.CERT_AVAILABLE != 'true' }}
|
|
||||||
env:
|
|
||||||
CSC_IDENTITY_AUTO_DISCOVERY: 'false'
|
|
||||||
run: npm run build:win-unsigned -- --publish=never
|
|
||||||
|
|
||||||
- name: Upload Windows artifacts
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: windows-artifacts
|
|
||||||
path: |
|
|
||||||
dist/*.exe
|
|
||||||
dist/*.zip
|
|
||||||
retention-days: 5
|
|
||||||
|
|
||||||
build-macos:
|
|
||||||
runs-on: macos-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Setup Node.js
|
|
||||||
uses: actions/setup-node@v4
|
|
||||||
with:
|
|
||||||
node-version: 20
|
|
||||||
cache: npm
|
|
||||||
|
|
||||||
- name: Install dependencies
|
|
||||||
run: npm ci
|
|
||||||
|
|
||||||
- name: Download external tools (pandoc)
|
|
||||||
run: node scripts/download-tools.js
|
|
||||||
|
|
||||||
- name: Bundle MarkItDown (optional, best effort)
|
|
||||||
run: npm run bundle:markitdown
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- name: Run tests
|
|
||||||
run: npm test
|
|
||||||
|
|
||||||
- name: Build macOS packages
|
|
||||||
run: npm run build:mac -- --publish=never
|
|
||||||
|
|
||||||
- name: Upload macOS artifacts
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
name: macos-artifacts
|
|
||||||
path: |
|
|
||||||
dist/*.dmg
|
|
||||||
dist/*.zip
|
|
||||||
retention-days: 5
|
|
||||||
|
|
||||||
release:
|
|
||||||
needs: [build-linux, build-windows, build-macos]
|
|
||||||
if: always()
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Download Linux artifacts
|
|
||||||
uses: actions/download-artifact@v4
|
|
||||||
continue-on-error: true
|
|
||||||
with:
|
|
||||||
name: linux-artifacts
|
|
||||||
path: dist
|
|
||||||
|
|
||||||
- name: Download Windows artifacts
|
|
||||||
uses: actions/download-artifact@v4
|
|
||||||
continue-on-error: true
|
|
||||||
with:
|
|
||||||
name: windows-artifacts
|
|
||||||
path: dist
|
|
||||||
|
|
||||||
- name: Download macOS artifacts
|
|
||||||
uses: actions/download-artifact@v4
|
|
||||||
continue-on-error: true
|
|
||||||
with:
|
|
||||||
name: macos-artifacts
|
|
||||||
path: dist
|
|
||||||
|
|
||||||
- name: Create GitHub Release
|
|
||||||
uses: softprops/action-gh-release@v2
|
|
||||||
with:
|
|
||||||
generate_release_notes: true
|
|
||||||
files: dist/*
|
|
||||||
-48
@@ -1,48 +0,0 @@
|
|||||||
node_modules/
|
|
||||||
dist/
|
|
||||||
*.log
|
|
||||||
.DS_Store
|
|
||||||
Thumbs.db
|
|
||||||
.env
|
|
||||||
.env.local
|
|
||||||
*.swp
|
|
||||||
*.swo
|
|
||||||
*~
|
|
||||||
.vscode/*
|
|
||||||
!.vscode/launch.json
|
|
||||||
.idea/
|
|
||||||
*.iml
|
|
||||||
out/
|
|
||||||
.cache/
|
|
||||||
.npm/
|
|
||||||
.electron/
|
|
||||||
# package-lock.json is intentionally tracked for reproducible CI builds
|
|
||||||
|
|
||||||
# Downloaded tool binaries (fetched at build time via scripts/download-tools.js)
|
|
||||||
bin/
|
|
||||||
|
|
||||||
# Code signing certificates — never commit private keys
|
|
||||||
*.pfx
|
|
||||||
*.p12
|
|
||||||
|
|
||||||
# Screenshots and temp files
|
|
||||||
*.png.bak
|
|
||||||
Screen.png
|
|
||||||
dark.png
|
|
||||||
light.png
|
|
||||||
pdf.png
|
|
||||||
uvmodal.png
|
|
||||||
nul
|
|
||||||
*.tmp
|
|
||||||
|
|
||||||
# Development screenshots
|
|
||||||
pdf\ modal.png
|
|
||||||
|
|
||||||
# Claude/AI development files
|
|
||||||
.claude/
|
|
||||||
CLAUDE.md
|
|
||||||
agents.md
|
|
||||||
coverage/
|
|
||||||
|
|
||||||
# Superpowers brainstorm artifacts
|
|
||||||
.superpowers/
|
|
||||||
-11
@@ -1,11 +0,0 @@
|
|||||||
{
|
|
||||||
"semi": true,
|
|
||||||
"singleQuote": true,
|
|
||||||
"tabWidth": 2,
|
|
||||||
"useTabs": false,
|
|
||||||
"trailingComma": "es5",
|
|
||||||
"bracketSpacing": true,
|
|
||||||
"arrowParens": "always",
|
|
||||||
"printWidth": 100,
|
|
||||||
"endOfLine": "auto"
|
|
||||||
}
|
|
||||||
@@ -1,469 +0,0 @@
|
|||||||
# Security Assessment Report: MarkdownConverter v4.0.0
|
|
||||||
|
|
||||||
**Assessment Date:** 2026-03-15
|
|
||||||
**Application:** MarkdownConverter - Electron-based Markdown editor and document converter
|
|
||||||
**Target Version:** 4.0.0
|
|
||||||
**Assessor:** Security Audit Agent
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Executive Summary
|
|
||||||
|
|
||||||
This assessment identified **10 security findings** ranging from **Critical to Low severity**. The most significant concerns involve insecure Electron security configuration that could allow XSS attacks to escalate to full system access, arbitrary code execution via the REPL feature, and missing input validation on file operations.
|
|
||||||
|
|
||||||
| Severity | Count |
|
|
||||||
|----------|-------|
|
|
||||||
| Critical | 2 |
|
|
||||||
| High | 3 |
|
|
||||||
| Medium | 3 |
|
|
||||||
| Low | 2 |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Vulnerability Findings
|
|
||||||
|
|
||||||
### CVE-MC-001: Insecure Electron Security Configuration (Critical)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 9.6 (Critical)**
|
|
||||||
**CWE-265: CWE-1021: Improper Restriction of Renderers**
|
|
||||||
|
|
||||||
**Location:** `src/main.js` (lines 328-332)
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
webPreferences: {
|
|
||||||
nodeIntegration: true,
|
|
||||||
contextIsolation: false,
|
|
||||||
spellcheck: true
|
|
||||||
},
|
|
||||||
```
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
The main application window has `nodeIntegration: true` and `contextIsolation: false`, which is the most insecure Electron configuration. This allows the renderer process direct access to Node.js APIs, meaning any XSS vulnerability in the markdown rendering or external content could lead to full system compromise.
|
|
||||||
|
|
||||||
**Exploitability:**
|
|
||||||
- An attacker who can inject malicious JavaScript (via markdown files, XSS in preview, or compromised dependencies) gains immediate access to:
|
|
||||||
- Full file system read/write via `fs` module
|
|
||||||
- Command execution via `child_process`
|
|
||||||
- Network access via `net` module
|
|
||||||
- All system resources
|
|
||||||
|
|
||||||
**Attack Scenario:**
|
|
||||||
1. User opens a malicious markdown file containing embedded JavaScript
|
|
||||||
2. The JavaScript executes in the renderer with full Node.js access
|
|
||||||
3. Attacker can read sensitive files, execute commands, exfiltrate data
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
```javascript
|
|
||||||
webPreferences: {
|
|
||||||
nodeIntegration: false,
|
|
||||||
contextIsolation: true,
|
|
||||||
sandbox: true,
|
|
||||||
preload: path.join(__dirname, 'preload.js')
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Note:** The preload.js file already implements a secure IPC bridge but it is not being utilized for the main window.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-002: Arbitrary Code Execution via REPL Feature (Critical)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 9.3 (Critical)**
|
|
||||||
**CWE-94: Improper Control of Generation of Code ('Code Injection')**
|
|
||||||
|
|
||||||
**Location:** `src/main.js` (lines 4369-4396)
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
The `execute-code` IPC handler allows execution of arbitrary Python and Bash scripts through the REPL panel. While JavaScript execution appears to have been removed or limited, Python and Bash commands are executed via `execFile` with user-supplied code.
|
|
||||||
|
|
||||||
**Vulnerable Code Pattern:**
|
|
||||||
```javascript
|
|
||||||
ipcMain.handle('execute-code', async (event, { code, language }) => {
|
|
||||||
// ...
|
|
||||||
if (language === 'python' || language === 'py') {
|
|
||||||
cmd = 'python';
|
|
||||||
args = ['-c', code];
|
|
||||||
}
|
|
||||||
// ...
|
|
||||||
execFile(cmd, args, { timeout }, (err, stdout, stderr) => {
|
|
||||||
// ...
|
|
||||||
});
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
**Exploitability:**
|
|
||||||
- Users can be tricked into running malicious code blocks
|
|
||||||
- Markdown files can contain executable code blocks with "Run" buttons
|
|
||||||
- No sandboxing or permission restrictions on executed code
|
|
||||||
|
|
||||||
**Attack Scenario:**
|
|
||||||
1. Attacker creates markdown file with malicious Python code block
|
|
||||||
2. User clicks "Run" button in preview
|
|
||||||
3. Python code executes with user's full permissions
|
|
||||||
4. Attacker gains code execution on victim's machine
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
- Remove arbitrary code execution feature entirely, OR
|
|
||||||
- Implement strict sandboxing (Docker, VM, or restricted Python environment)
|
|
||||||
- Add user confirmation dialogs with clear warnings
|
|
||||||
- Execute in isolated environment with no filesystem/network access
|
|
||||||
- Implement allowlist of safe operations
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-003: Potential XSS in Markdown Rendering (High)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 8.0 (High)**
|
|
||||||
**CWE-79: Improper Neutralization of Input During Web Page Generation ('Cross-site Scripting')**
|
|
||||||
|
|
||||||
**Location:** `src/renderer.js` (lines 387-419)
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
While DOMPurify is used to sanitize HTML, several extensions to marked.js may bypass sanitization:
|
|
||||||
|
|
||||||
1. **Custom Admonition Extension (lines 51-77):**
|
|
||||||
```javascript
|
|
||||||
marked.use({
|
|
||||||
extensions: [{
|
|
||||||
name: 'admonition',
|
|
||||||
// ...
|
|
||||||
renderer(token) {
|
|
||||||
const inner = this.parser.parse(token.text);
|
|
||||||
return `<div class="admonition admonition-${token.admonitionType}">
|
|
||||||
<div class="admonition-title">${icon} ${token.admonitionType...}</div>
|
|
||||||
<div class="admonition-content">${inner}</div>
|
|
||||||
</div>`;
|
|
||||||
}
|
|
||||||
}]
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **innerHTML Assignments (line 419):**
|
|
||||||
```javascript
|
|
||||||
preview.innerHTML = sanitizedHtml;
|
|
||||||
```
|
|
||||||
|
|
||||||
**Exploitability:**
|
|
||||||
- Combined with CVE-MC-001, XSS leads to full system compromise
|
|
||||||
- Custom markdown extensions may not be properly sanitized
|
|
||||||
- Admonition type is directly interpolated into HTML without escaping
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
- Ensure all custom markdown extensions escape user input
|
|
||||||
- Add Content Security Policy that blocks inline scripts
|
|
||||||
- Use `textContent` instead of `innerHTML` where possible
|
|
||||||
- Audit all custom marked.js extensions for XSS vectors
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-004: Missing Path Traversal Protection (High)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 7.8 (High)**
|
|
||||||
**CWE-22: Improper Limitation of a Pathname to a Restricted Directory ('Path Traversal')**
|
|
||||||
|
|
||||||
**Location:** `src/main.js` (lines 4241-4281)
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
The `list-directory` and `open-file-path` IPC handlers accept arbitrary file paths without validation:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
ipcMain.handle('list-directory', async (event, dirPath) => {
|
|
||||||
try {
|
|
||||||
if (!dirPath) { /* dialog */ }
|
|
||||||
// No path validation - accepts any path
|
|
||||||
const entries = fs.readdirSync(dirPath, { withFileTypes: true });
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
ipcMain.on('open-file-path', (event, filePath) => {
|
|
||||||
// No path validation
|
|
||||||
if (!fs.existsSync(filePath)) return;
|
|
||||||
const content = fs.readFileSync(filePath, 'utf-8');
|
|
||||||
mainWindow.webContents.send('file-opened', { path: filePath, content });
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
**Exploitability:**
|
|
||||||
- Malicious renderer code can read any file on the system
|
|
||||||
- No restriction to a sandbox directory
|
|
||||||
- Combined with XSS, attacker can exfiltrate sensitive files
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
```javascript
|
|
||||||
const ALLOWED_DIRECTORIES = [app.getPath('documents'), app.getPath('desktop')];
|
|
||||||
|
|
||||||
function isPathAllowed(filePath) {
|
|
||||||
const resolved = path.resolve(filePath);
|
|
||||||
return ALLOWED_DIRECTORIES.some(dir => resolved.startsWith(dir));
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-005: Weak Content Security Policy (High)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 7.5 (High)**
|
|
||||||
**CWE-1021: Improper Restriction of Renderers**
|
|
||||||
|
|
||||||
**Location:** `src/index.html` (line 5)
|
|
||||||
|
|
||||||
```html
|
|
||||||
<meta http-equiv="Content-Security-Policy" content="default-src 'self';
|
|
||||||
script-src 'self' 'unsafe-inline' 'unsafe-eval' https://cdn.jsdelivr.net;
|
|
||||||
style-src 'self' 'unsafe-inline' https://cdnjs.cloudflare.com;
|
|
||||||
img-src 'self' data: blob: file:;
|
|
||||||
font-src 'self' data:;
|
|
||||||
connect-src 'self' https://www.plantuml.com;">
|
|
||||||
```
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
The CSP contains several security weaknesses:
|
|
||||||
|
|
||||||
1. **`'unsafe-inline'` in script-src** - Allows inline script injection
|
|
||||||
2. **`'unsafe-eval'` in script-src** - Allows `eval()` and similar functions
|
|
||||||
3. **`https://cdn.jsdelivr.net`** - Allows scripts from external CDN (supply chain risk)
|
|
||||||
4. **`file:` in img-src** - Allows loading local files as images (potential information disclosure)
|
|
||||||
|
|
||||||
**Exploitability:**
|
|
||||||
- XSS attacks can execute arbitrary scripts
|
|
||||||
- External CDN compromise could inject malicious code
|
|
||||||
- `eval()` enables dynamic code execution
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
- Remove `'unsafe-inline'` and `'unsafe-eval'`
|
|
||||||
- Use nonces or hashes for inline scripts
|
|
||||||
- Remove external CDNs or use Subresource Integrity (SRI)
|
|
||||||
- Remove `file:` from img-src
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-006: Insecure Window Configuration for PDF Export (Medium)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 6.5 (Medium)**
|
|
||||||
**CWE-1021: Improper Restriction of Renderers**
|
|
||||||
|
|
||||||
**Location:** `src/main.js` (lines 2579-2585)
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const pdfWindow = new BrowserWindow({
|
|
||||||
show: false,
|
|
||||||
webPreferences: {
|
|
||||||
nodeIntegration: true,
|
|
||||||
contextIsolation: false
|
|
||||||
}
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Hidden windows created for PDF export also have insecure configurations, allowing potential privilege escalation.
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
```javascript
|
|
||||||
webPreferences: {
|
|
||||||
nodeIntegration: false,
|
|
||||||
contextIsolation: true,
|
|
||||||
sandbox: true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-007: PlantUML Server Data Exfiltration (Medium)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 5.3 (Medium)**
|
|
||||||
**CWE-359: Exposure of Private Information**
|
|
||||||
|
|
||||||
**Location:** `src/renderer.js` (lines 470-487)
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
const plantumlBlocks = preview.querySelectorAll('pre code.language-plantuml');
|
|
||||||
plantumlBlocks.forEach((block) => {
|
|
||||||
const code = block.textContent;
|
|
||||||
// ...
|
|
||||||
const encoded = plantumlEncode(code);
|
|
||||||
const img = document.createElement('img');
|
|
||||||
img.src = `https://www.plantuml.com/plantuml/svg/${encoded}`;
|
|
||||||
// ...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
PlantUML diagram content is sent to an external server (plantuml.com) for rendering. This could leak sensitive information contained in diagrams.
|
|
||||||
|
|
||||||
**Exploitability:**
|
|
||||||
- Diagrams containing proprietary information, system architecture, or internal processes are sent to third-party servers
|
|
||||||
- No user consent or notification before external data transmission
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
- Use local PlantUML rendering with Java
|
|
||||||
- Add user warning before sending data to external service
|
|
||||||
- Implement opt-in for external rendering
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-008: Inconsistent Security Settings Across Windows (Medium)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 5.5 (Medium)**
|
|
||||||
**CWE-1021: Improper Restriction of Renderers**
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Security settings are inconsistent across different windows:
|
|
||||||
|
|
||||||
| Window | nodeIntegration | contextIsolation | Security |
|
|
||||||
|--------|-----------------|------------------|----------|
|
|
||||||
| Main Window | true | false | Insecure |
|
|
||||||
| About Dialog | false | true | Secure |
|
|
||||||
| Dependencies Dialog | false | true | Secure |
|
|
||||||
| ASCII Generator | false | true | Secure |
|
|
||||||
| Table Generator | false | true | Secure |
|
|
||||||
| PDF Export Window | true | false | Insecure |
|
|
||||||
| Hidden Conversion Window | true | false | Insecure |
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
Apply secure configuration (`nodeIntegration: false`, `contextIsolation: true`) consistently across all windows.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-009: Command Execution via External Tools (Low)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 4.4 (Low)**
|
|
||||||
**CWE-78: Improper Neutralization of Special Elements used in an OS Command ('OS Command Injection')**
|
|
||||||
|
|
||||||
**Location:** `src/main.js` (lines 1915-1972)
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
While the application uses `execFile` instead of `exec` (good practice), external tools (Pandoc, LibreOffice, FFmpeg, ImageMagick) are invoked with file paths that could potentially be manipulated.
|
|
||||||
|
|
||||||
**Positive Finding:**
|
|
||||||
The code correctly uses `execFile` with argument arrays instead of shell commands, mitigating most command injection vectors.
|
|
||||||
|
|
||||||
**Remaining Risk:**
|
|
||||||
- File paths are not validated against malicious names
|
|
||||||
- Special characters in filenames could cause issues with external tools
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
- Validate file paths before passing to external tools
|
|
||||||
- Sanitize filenames of special characters
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### CVE-MC-010: Missing Dependency Version Pinning (Low)
|
|
||||||
|
|
||||||
**CVSS 3.1 Score: 3.5 (Low)**
|
|
||||||
**CWE-1035: Using Components with Known Vulnerabilities**
|
|
||||||
|
|
||||||
**Location:** `package.json`
|
|
||||||
|
|
||||||
**Description:**
|
|
||||||
Dependencies use `^` version ranges which could allow automatic updates to versions with vulnerabilities:
|
|
||||||
|
|
||||||
```json
|
|
||||||
"dependencies": {
|
|
||||||
"marked": "^17.0.3",
|
|
||||||
"dompurify": "^3.3.1",
|
|
||||||
"mermaid": "^11.12.3",
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Remediation:**
|
|
||||||
- Pin exact versions in production
|
|
||||||
- Use lockfile (package-lock.json)
|
|
||||||
- Implement dependency scanning in CI/CD pipeline
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Attack Surface Map
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ EXTERNAL ATTACK SURFACE │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ Markdown Files (.md) ─────► XSS via Preview Rendering │
|
|
||||||
│ Code Blocks ─────► Arbitrary Code Execution │
|
|
||||||
│ PlantUML Diagrams ─────► Data Exfiltration │
|
|
||||||
│ External CDNs ─────► Supply Chain Attacks │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ RENDERER PROCESS (Insecure) │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ nodeIntegration: true ─────► Direct Node.js Access │
|
|
||||||
│ contextIsolation: false ─────► Prototype Pollution Risk │
|
|
||||||
│ DOMPurify Sanitization ─────► May be bypassed via extensions │
|
|
||||||
│ Custom Marked Extensions ────► XSS Vectors │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ IPC BRIDGE (Preload.js) │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ Channel Whitelisting ─────► Good Practice │
|
|
||||||
│ Not Used for Main Window ────► Security Bypassed │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
┌─────────────────────────────────────────────────────────────────┐
|
|
||||||
│ MAIN PROCESS (Full Privileges) │
|
|
||||||
├─────────────────────────────────────────────────────────────────┤
|
|
||||||
│ File Operations ─────► No Path Validation │
|
|
||||||
│ Code Execution ─────► Python/Bash via REPL │
|
|
||||||
│ External Tools ─────► Pandoc, FFmpeg, LibreOffice │
|
|
||||||
│ PDF Operations ─────► Merge, Encrypt, Decrypt │
|
|
||||||
└─────────────────────────────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Positive Security Findings
|
|
||||||
|
|
||||||
1. **Preload.js Implementation:** A secure IPC bridge with channel whitelisting is implemented
|
|
||||||
2. **DOMPurify Usage:** HTML sanitization is applied to markdown output
|
|
||||||
3. **execFile Usage:** External commands use `execFile` instead of `exec`
|
|
||||||
4. **File Size Limits:** 50MB maximum file size is enforced
|
|
||||||
5. **Rate Limiting:** Conversion operations have rate limiting (2 second minimum interval)
|
|
||||||
6. **Error Message Sanitization:** Absolute paths are stripped from error messages
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Prioritized Remediation Roadmap
|
|
||||||
|
|
||||||
### Phase 1 - Critical (Immediate)
|
|
||||||
1. Set `nodeIntegration: false` and `contextIsolation: true` for main window
|
|
||||||
2. Remove or sandbox the code execution (REPL) feature
|
|
||||||
3. Implement proper preload.js usage for all windows
|
|
||||||
|
|
||||||
### Phase 2 - High Priority (1-2 Weeks)
|
|
||||||
4. Add path traversal protection to file operations
|
|
||||||
5. Strengthen Content Security Policy
|
|
||||||
6. Audit and fix custom markdown extensions for XSS
|
|
||||||
|
|
||||||
### Phase 3 - Medium Priority (1 Month)
|
|
||||||
7. Implement consistent security settings across all windows
|
|
||||||
8. Add local PlantUML rendering option
|
|
||||||
9. Implement dependency scanning in CI/CD
|
|
||||||
|
|
||||||
### Phase 4 - Low Priority (Ongoing)
|
|
||||||
10. Pin dependency versions
|
|
||||||
11. Add security headers to all generated HTML
|
|
||||||
12. Implement security logging and monitoring
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Compliance Considerations
|
|
||||||
|
|
||||||
- **OWASP Top 10 2021:** A03:2021 - Injection, A05:2021 - Security Misconfiguration
|
|
||||||
- **OWASP ASVS:** V12 - File Handling, V13 - API Security
|
|
||||||
- **NIST CSF:** PR.AC - Access Control, PR.DS - Data Security
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Conclusion
|
|
||||||
|
|
||||||
The MarkdownConverter application has significant security vulnerabilities that could allow an attacker to execute arbitrary code, access sensitive files, and compromise the user's system. The most critical issue is the insecure Electron configuration combined with XSS attack vectors in the markdown rendering pipeline.
|
|
||||||
|
|
||||||
**Overall Security Rating: HIGH RISK**
|
|
||||||
|
|
||||||
The positive finding is that much of the security infrastructure (preload.js, DOMPurify) is already in place but not properly utilized. With focused remediation effort, the application can achieve a much stronger security posture.
|
|
||||||
@@ -1,215 +0,0 @@
|
|||||||
# STRIDE Threat Model - MarkdownConverter v4.0.0
|
|
||||||
|
|
||||||
**Analysis Date:** 2026-03-15
|
|
||||||
**Methodology:** STRIDE + MITRE ATT&CK
|
|
||||||
**Overall Risk Score:** 7.8 (HIGH)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Executive Summary
|
|
||||||
|
|
||||||
The analysis identified **10 vulnerabilities** with a combined risk score of **7.8 (HIGH)**. The most critical issues enable complete system compromise through XSS-to-RCE attack chains.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Critical Findings
|
|
||||||
|
|
||||||
| Priority | CVE | Vulnerability | CVSS | Impact |
|
|
||||||
|----------|-----|---------------|------|--------|
|
|
||||||
| P0 | CVE-MC-001 | Insecure Electron Config (`nodeIntegration: true`, `contextIsolation: false`) | 9.6 | Complete system compromise |
|
|
||||||
| P0 | CVE-MC-002 | Arbitrary code execution via REPL feature | 9.3 | Remote code execution |
|
|
||||||
| P1 | CVE-MC-003 | XSS in markdown rendering | 8.0 | Session hijacking, RCE chain |
|
|
||||||
| P1 | CVE-MC-004 | Path traversal vulnerability | 7.8 | Arbitrary file write |
|
|
||||||
| P1 | CVE-MC-005 | Weak Content Security Policy | 7.5 | XSS enablement |
|
|
||||||
| P2 | CVE-MC-006 | Insecure window config for PDF export | 6.5 | Privilege escalation |
|
|
||||||
| P2 | CVE-MC-007 | PlantUML server data exfiltration | 5.3 | Information disclosure |
|
|
||||||
| P2 | CVE-MC-008 | Inconsistent security settings | 5.5 | Configuration weakness |
|
|
||||||
| P3 | CVE-MC-009 | Command execution via external tools | 4.4 | Command injection risk |
|
|
||||||
| P3 | CVE-MC-010 | Missing dependency version pinning | 3.5 | Supply chain risk |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Key Attack Vectors
|
|
||||||
|
|
||||||
### 1. XSS to RCE Chain (Critical)
|
|
||||||
```
|
|
||||||
Malicious Markdown File
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
XSS in Preview (CVE-MC-003)
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
nodeIntegration: true (CVE-MC-001)
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
Full Node.js Access
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
Complete System Compromise
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. REPL Code Execution (Critical)
|
|
||||||
```
|
|
||||||
Code Block in Markdown
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
User clicks "Run"
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
REPL executes Python/Bash (CVE-MC-002)
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
Arbitrary Code Execution
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. Data Exfiltration (Medium)
|
|
||||||
```
|
|
||||||
PlantUML Diagram Content
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
Sent to www.plantuml.com (CVE-MC-007)
|
|
||||||
│
|
|
||||||
▼
|
|
||||||
Sensitive Architecture Leaked
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## STRIDE Analysis
|
|
||||||
|
|
||||||
### S - Spoofing
|
|
||||||
| ID | Threat | Likelihood | Impact | Risk |
|
|
||||||
|----|--------|------------|--------|------|
|
|
||||||
| S1 | Attacker spoofs markdown file origin | Medium | High | High |
|
|
||||||
| S2 | Malicious code pretends to be safe | High | Critical | Critical |
|
|
||||||
|
|
||||||
### T - Tampering
|
|
||||||
| ID | Threat | Likelihood | Impact | Risk |
|
|
||||||
|----|--------|------------|--------|------|
|
|
||||||
| T1 | XSS modifies local files | High | Critical | Critical |
|
|
||||||
| T2 | Conversion output tampered | Medium | Medium | Medium |
|
|
||||||
|
|
||||||
### R - Repudiation
|
|
||||||
| ID | Threat | Likelihood | Impact | Risk |
|
|
||||||
|----|--------|------------|--------|------|
|
|
||||||
| R1 | No audit trail for operations | Low | Low | Low |
|
|
||||||
|
|
||||||
### I - Information Disclosure
|
|
||||||
| ID | Threat | Likelihood | Impact | Risk |
|
|
||||||
|----|--------|------------|--------|------|
|
|
||||||
| I1 | XSS exposes file system | High | Critical | Critical |
|
|
||||||
| I2 | PlantUML content leaked | Medium | Medium | Medium |
|
|
||||||
| I3 | Error messages reveal paths | Low | Low | Low |
|
|
||||||
|
|
||||||
### D - Denial of Service
|
|
||||||
| ID | Threat | Likelihood | Impact | Risk |
|
|
||||||
|----|--------|------------|--------|------|
|
|
||||||
| D1 | Malicious code crashes app | Medium | Medium | Medium |
|
|
||||||
| D2 | Large file exhausts resources | Low | Low | Low |
|
|
||||||
|
|
||||||
### E - Elevation of Privilege
|
|
||||||
| ID | Threat | Likelihood | Impact | Risk |
|
|
||||||
|----|--------|------------|--------|------|
|
|
||||||
| E1 | XSS → nodeIntegration → System | High | Critical | Critical |
|
|
||||||
| E2 | REPL code execution | High | Critical | Critical |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## MITRE ATT&CK Mapping
|
|
||||||
|
|
||||||
| Technique | ID | Applicability |
|
|
||||||
|-----------|-----|---------------|
|
|
||||||
| User Execution | T1204.002 | Malicious markdown file |
|
|
||||||
| Command and Scripting Interpreter | T1059.007 | JavaScript via nodeIntegration |
|
|
||||||
| Command and Scripting Interpreter | T1059.006 | Python via REPL |
|
|
||||||
| Command and Scripting Interpreter | T1059.004 | Bash via REPL |
|
|
||||||
| Exploit Public-Facing Application | T1190 | XSS in preview |
|
|
||||||
| Data Exfiltration Over Web Service | T1043 | PlantUML server |
|
|
||||||
| File and Directory Discovery | T1083 | Path traversal |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Trust Boundaries
|
|
||||||
|
|
||||||
```
|
|
||||||
┌─────────────────────────────────────────────────────────────────────┐
|
|
||||||
│ TRUST BOUNDARY MAP │
|
|
||||||
├─────────────────────────────────────────────────────────────────────┤
|
|
||||||
│ │
|
|
||||||
│ ┌─────────────┐ ┌─────────────────────────────────────┐ │
|
|
||||||
│ │ USER │ ──────► │ APPLICATION │ │
|
|
||||||
│ │ (Untrusted) │ │ ┌───────────┐ ┌───────────────┐ │ │
|
|
||||||
│ └─────────────┘ │ │ Renderer │ │ Main Process │ │ │
|
|
||||||
│ │ │ (Sandbox) │ │ (Privileged) │ │ │
|
|
||||||
│ │ └─────┬─────┘ └───────┬───────┘ │ │
|
|
||||||
│ │ │ IPC │ │ │
|
|
||||||
│ │ ▼ ▼ │ │
|
|
||||||
│ │ ┌─────────────────────────────┐ │ │
|
|
||||||
│ │ │ File System │ │ │
|
|
||||||
│ │ └─────────────────────────────┘ │ │
|
|
||||||
│ └─────────────────────────────────────┘ │
|
|
||||||
│ │ │
|
|
||||||
│ ▼ │
|
|
||||||
│ ┌─────────────────────────────────────────────────────────────┐ │
|
|
||||||
│ │ EXTERNAL SERVICES │ │
|
|
||||||
│ │ • PlantUML Server (www.plantuml.com) │ │
|
|
||||||
│ │ • CDN (cdn.jsdelivr.net, cdnjs.cloudflare.com) [REMOVED] │ │
|
|
||||||
│ │ • External Tools (Pandoc, FFmpeg, LibreOffice) │ │
|
|
||||||
│ └─────────────────────────────────────────────────────────────┘ │
|
|
||||||
│ │
|
|
||||||
└─────────────────────────────────────────────────────────────────────┘
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Business Impact Analysis
|
|
||||||
|
|
||||||
### Successful Attack Consequences
|
|
||||||
|
|
||||||
| Impact Category | Estimate |
|
|
||||||
|-----------------|----------|
|
|
||||||
| Data breach costs | $500,000 - $5,000,000+ |
|
|
||||||
| Regulatory fines (GDPR) | Up to 4% annual revenue |
|
|
||||||
| Reputation damage | Incalculable |
|
|
||||||
| Business disruption | Hours to days |
|
|
||||||
|
|
||||||
### Affected Assets
|
|
||||||
- User documents and files
|
|
||||||
- System credentials
|
|
||||||
- Proprietary information in diagrams
|
|
||||||
- Application integrity
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Remediation Priority
|
|
||||||
|
|
||||||
### P0 - Immediate (24-48 hours)
|
|
||||||
1. **CVE-MC-001**: Set `nodeIntegration: false`, `contextIsolation: true`
|
|
||||||
2. **CVE-MC-002**: Remove or sandbox REPL code execution
|
|
||||||
|
|
||||||
### P1 - Short-term (1-2 weeks)
|
|
||||||
3. **CVE-MC-003**: Audit markdown extensions for XSS
|
|
||||||
4. **CVE-MC-004**: Add path validation (✅ COMPLETED)
|
|
||||||
5. **CVE-MC-005**: Strengthen CSP (✅ COMPLETED)
|
|
||||||
|
|
||||||
### P2 - Medium-term (1 month)
|
|
||||||
6. **CVE-MC-006**: Consistent window security settings
|
|
||||||
7. **CVE-MC-007**: Add local PlantUML option or warning
|
|
||||||
8. **CVE-MC-008**: Audit all BrowserWindow configurations
|
|
||||||
|
|
||||||
### P3 - Long-term
|
|
||||||
9. **CVE-MC-009**: Validate filenames for external tools
|
|
||||||
10. **CVE-MC-010**: Pin dependency versions, add scanning
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Conclusion
|
|
||||||
|
|
||||||
The MarkdownConverter application has a **HIGH RISK** threat profile due to the combination of:
|
|
||||||
- Untrusted content rendering (markdown preview)
|
|
||||||
- Direct system access (nodeIntegration)
|
|
||||||
- Code execution capability (REPL)
|
|
||||||
|
|
||||||
**Immediate action required on P0 items to reduce attack surface.**
|
|
||||||
|
|
||||||
The fixes applied in this session (CSP, path traversal, UI accessibility) have reduced the risk profile, but the critical nodeIntegration issue requires significant refactoring.
|
|
||||||
@@ -1,27 +0,0 @@
|
|||||||
{
|
|
||||||
"target": "MarkdownConverter Electron Application",
|
|
||||||
"status": "in_progress",
|
|
||||||
"depth": "comprehensive",
|
|
||||||
"compliance_frameworks": ["owasp"],
|
|
||||||
"current_step": 3,
|
|
||||||
"current_phase": 1,
|
|
||||||
"completed_steps": ["vulnerability-scan", "threat-modeling"],
|
|
||||||
"files_created": ["01-vulnerability-scan.md", "02-threat-model.md"],
|
|
||||||
"started_at": "2026-03-15T00:09:00.000Z",
|
|
||||||
"last_updated": "2026-03-15T00:25:00.000Z",
|
|
||||||
"findings_summary": {
|
|
||||||
"critical": 2,
|
|
||||||
"high": 3,
|
|
||||||
"medium": 3,
|
|
||||||
"low": 2,
|
|
||||||
"total": 10
|
|
||||||
},
|
|
||||||
"fixes_applied": {
|
|
||||||
"csp_external_cdns_removed": true,
|
|
||||||
"path_traversal_protection_added": true,
|
|
||||||
"aria_labels_added": true,
|
|
||||||
"focus_visible_styles_added": true,
|
|
||||||
"tab_close_button_resized": true,
|
|
||||||
"duplicate_font_size_fixed": true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,522 +0,0 @@
|
|||||||
# Comprehensive UI Design Review - MarkdownConverter Electron Application
|
|
||||||
|
|
||||||
## Executive Summary
|
|
||||||
|
|
||||||
This review covers the UI design of the MarkdownConverter Electron application, analyzing visual design, usability, code quality, and performance across all UI files. The application has a solid foundation but has several areas requiring attention.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. Visual Design Review
|
|
||||||
|
|
||||||
### 1.1 Spacing & Layout Consistency
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Inconsistent padding values across files | Multiple CSS files | Standardize to 4px/8px base scale |
|
|
||||||
| **Major** | Multiple reset declarations | `styles.css:1-5`, `styles-modern.css:42-47` | Consolidate resets into single file |
|
|
||||||
| **Minor** | Tab padding varies between themes | `styles.css:36`, `styles-modern.css:101` | Use CSS variables for consistent padding |
|
|
||||||
| **Minor** | Container padding inconsistency | `styles.css:17-21`, `styles-modern.css:63-69` | Define single container style |
|
|
||||||
|
|
||||||
**Code Example - Duplicate Reset:**
|
|
||||||
|
|
||||||
```css
|
|
||||||
/* styles.css:1-5 */
|
|
||||||
* {
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
box-sizing: border-box;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* styles-modern.css:42-47 - DUPLICATE */
|
|
||||||
* {
|
|
||||||
margin: 0;
|
|
||||||
padding: 0;
|
|
||||||
box-sizing: border-box;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
/* Create a single base.css or remove from styles-modern.css */
|
|
||||||
/* Use CSS variables for spacing scale */
|
|
||||||
:root {
|
|
||||||
--space-1: 4px;
|
|
||||||
--space-2: 8px;
|
|
||||||
--space-3: 12px;
|
|
||||||
--space-4: 16px;
|
|
||||||
--space-5: 24px;
|
|
||||||
--space-6: 32px;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 1.2 Typography Consistency
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Font-family declared multiple times with different fallbacks | `styles.css:8`, `styles-modern.css:50`, `styles-concreteinfo.css:32` | Standardize font stack |
|
|
||||||
| **Major** | Duplicate font-size declarations | `styles.css:228-230` | Remove duplicate |
|
|
||||||
| **Minor** | Inconsistent line-height values | Multiple files | Create type scale variables |
|
|
||||||
|
|
||||||
**Code Example - Duplicate font-size:**
|
|
||||||
```css
|
|
||||||
/* styles.css:226-230 */
|
|
||||||
.preview-content {
|
|
||||||
max-width: none;
|
|
||||||
margin: 0;
|
|
||||||
padding: 20px 24px 24px 24px;
|
|
||||||
line-height: 1.6;
|
|
||||||
font-size: 15px;
|
|
||||||
font-size: 14px; /* DUPLICATE - overwrites previous */
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
/* styles.css - Remove duplicate */
|
|
||||||
.preview-content {
|
|
||||||
font-size: 14px; /* Keep only one */
|
|
||||||
line-height: 1.6;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 1.3 Color Usage and Contrast Accessibility
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Critical** | Hardcoded colors instead of CSS variables | `styles.css:27-29`, `styles.css:37-38`, etc. | Use CSS custom properties |
|
|
||||||
| **Major** | Inconsistent gray scale definitions | Multiple files define different grays | Consolidate to single palette |
|
|
||||||
| **Minor** | Some contrast ratios may be insufficient | Status bar text colors | Verify WCAG 2.1 AA compliance |
|
|
||||||
|
|
||||||
**Code Example - Hardcoded colors:**
|
|
||||||
```css
|
|
||||||
/* styles.css:27-29 */
|
|
||||||
.tab-bar {
|
|
||||||
background: #f0f0f0; /* Should use var(--gray-100) */
|
|
||||||
border-bottom: 1px solid #ddd; /* Should use var(--gray-300) */
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
/* Use the existing palette from styles-modern.css */
|
|
||||||
.tab-bar {
|
|
||||||
background: var(--gray-100, #f3f4f6);
|
|
||||||
border-bottom: 1px solid var(--gray-300, #d1d5db);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 1.4 Dark Mode Support Quality
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Dark theme selectors inconsistent | `styles.css` uses `body.theme-dark`, `styles-sidebar.css:108` uses `body[class*="dark"]` | Standardize selector pattern |
|
|
||||||
| **Minor** | Missing dark theme support for some components | `.breadcrumb-bar`, command palette | Add dark mode variants |
|
|
||||||
| **Suggestion** | Repetitive dark theme declarations | `styles-concreteinfo.css:362-425` | Use CSS custom properties for theming |
|
|
||||||
|
|
||||||
**Code Example - Inconsistent selectors:**
|
|
||||||
```css
|
|
||||||
/* styles.css */
|
|
||||||
body.theme-dark .tab-bar { ... }
|
|
||||||
|
|
||||||
/* styles-sidebar.css */
|
|
||||||
body[class*="dark"] .sidebar-icons { ... }
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
/* Choose one pattern and apply consistently */
|
|
||||||
/* Option 1: Class-based (recommended) */
|
|
||||||
body.theme-dark .tab-bar,
|
|
||||||
body.theme-dark .sidebar-icons { ... }
|
|
||||||
|
|
||||||
/* Option 2: Attribute-based */
|
|
||||||
body[data-theme="dark"] .tab-bar { ... }
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. Usability Review
|
|
||||||
|
|
||||||
### 2.1 Clickable/Tappable Areas
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Critical** | Tab close button too small (16x16px) | `styles.css:62-77` | Increase to minimum 24x24px |
|
|
||||||
| **Major** | Sidebar icons at minimum size | `styles-sidebar.css:35-47` (36x36px) | Consider 40-44px for better touch |
|
|
||||||
| **Minor** | Toolbar buttons at edge of minimum | `styles.css:120-131` (32x32px) | Acceptable for mouse, small for touch |
|
|
||||||
|
|
||||||
**Code Example - Small close button:**
|
|
||||||
```css
|
|
||||||
/* styles.css:62-77 */
|
|
||||||
.tab-close {
|
|
||||||
width: 16px; /* TOO SMALL - below 24px minimum */
|
|
||||||
height: 16px; /* TOO SMALL */
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
.tab-close {
|
|
||||||
width: 24px;
|
|
||||||
height: 24px;
|
|
||||||
border-radius: 4px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Add touch-friendly hit area */
|
|
||||||
.tab-close::before {
|
|
||||||
content: '';
|
|
||||||
position: absolute;
|
|
||||||
top: -4px;
|
|
||||||
left: -4px;
|
|
||||||
right: -4px;
|
|
||||||
bottom: -4px;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2.2 Hover/Focus States
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Critical** | Missing focus-visible styles | All interactive elements | Add :focus-visible for keyboard navigation |
|
|
||||||
| **Major** | No focus indicators on toolbar buttons | `styles.css:133-140` | Add visible focus ring |
|
|
||||||
| **Minor** | Inconsistent hover transitions | Various components | Standardize transition duration |
|
|
||||||
|
|
||||||
**Code Example - Missing focus styles:**
|
|
||||||
```css
|
|
||||||
/* styles.css:120-131 - No focus state */
|
|
||||||
.toolbar button {
|
|
||||||
/* ... no focus style */
|
|
||||||
}
|
|
||||||
|
|
||||||
.toolbar button:hover {
|
|
||||||
background: #e0e0e0;
|
|
||||||
border-color: #ccc;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
.toolbar button:focus-visible {
|
|
||||||
outline: 2px solid var(--primary-dark, #5661b3);
|
|
||||||
outline-offset: 2px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.toolbar button:hover {
|
|
||||||
background: #e0e0e0;
|
|
||||||
border-color: #ccc;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2.3 Loading and Error State Handling
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Generic error message without styling | `renderer.js:384-386`, `renderer.js:508-511` | Create styled error components |
|
|
||||||
| **Minor** | No loading indicators for async operations | Sidebar panels | Add skeleton loaders or spinners |
|
|
||||||
| **Minor** | `git-loading` class exists but minimal styling | `styles-sidebar.css:227` | Enhance with animation |
|
|
||||||
|
|
||||||
**Code Example - Plain error display:**
|
|
||||||
```javascript
|
|
||||||
// renderer.js:384-386
|
|
||||||
preview.innerHTML = '<p style="color: red; padding: 20px;">Error: Required libraries...';
|
|
||||||
// Inline styles should be in CSS
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
/* Add to styles.css */
|
|
||||||
.preview-error {
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
padding: 40px 20px;
|
|
||||||
color: var(--ci-danger, #dc3545);
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
.preview-error-icon {
|
|
||||||
font-size: 48px;
|
|
||||||
margin-bottom: 16px;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2.4 Accessibility (ARIA, Semantic HTML)
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Critical** | Buttons without accessible labels | `index.html:31` (tab close), `index.html:33` (new tab) | Add aria-label |
|
|
||||||
| **Critical** | SVG icons lack aria-hidden | All toolbar buttons | Add aria-hidden="true" |
|
|
||||||
| **Major** | Missing role attributes on tabs | `index.html:29-33` | Add role="tablist", role="tab" |
|
|
||||||
| **Major** | No skip links | `index.html` | Add skip to main content link |
|
|
||||||
| **Minor** | Dialog missing aria-modal | Export dialogs | Add aria-modal="true" |
|
|
||||||
|
|
||||||
**Code Example - Missing accessibility attributes:**
|
|
||||||
```html
|
|
||||||
<!-- index.html:31 - Current -->
|
|
||||||
<button class="tab-close" title="Close tab">x</button>
|
|
||||||
|
|
||||||
<!-- index.html:33 - Current -->
|
|
||||||
<button class="new-tab-button" id="new-tab-btn" title="New tab">+</button>
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```html
|
|
||||||
<!-- Improved with ARIA -->
|
|
||||||
<div class="tab-bar" id="tab-bar" role="tablist" aria-label="Document tabs">
|
|
||||||
<div class="tab active" data-tab-id="1" role="tab" aria-selected="true" aria-controls="tab-content-1">
|
|
||||||
<span class="tab-title">Untitled</span>
|
|
||||||
<button class="tab-close" aria-label="Close tab" title="Close tab">×</button>
|
|
||||||
</div>
|
|
||||||
<button class="new-tab-button" id="new-tab-btn" aria-label="Create new tab" title="New tab">+</button>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- SVG icons should have aria-hidden -->
|
|
||||||
<button id="btn-bold" title="Bold (Ctrl+B)" aria-label="Bold">
|
|
||||||
<svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" aria-hidden="true">
|
|
||||||
...
|
|
||||||
</svg>
|
|
||||||
</button>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2.5 Keyboard Navigation
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Tab order may skip sidebar icons | Sidebar panel | Verify logical tab order |
|
|
||||||
| **Minor** | No escape key handling for dialogs | Export dialogs | Add escape to close |
|
|
||||||
| **Minor** | Find dialog lacks full keyboard support | `renderer.js:804-866` | Add Ctrl+F shortcut hint |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. Code Quality Review
|
|
||||||
|
|
||||||
### 3.1 CSS Organization & Naming
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | No clear CSS architecture | All CSS files | Adopt BEM or similar methodology |
|
|
||||||
| **Major** | Overly generic class names | `.pane`, `.tab`, `.container` | Use more specific naming |
|
|
||||||
| **Minor** | Mixed naming conventions | camelCase (`tabBar`), kebab-case (`tab-bar`) | Standardize to kebab-case |
|
|
||||||
| **Minor** | Magic numbers | Various pixel values | Replace with spacing variables |
|
|
||||||
|
|
||||||
### 3.2 CSS Specificity Issues
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Excessive use of `!important` | `styles.css:14` | Restructure to avoid |
|
|
||||||
| **Major** | Deep selector nesting | Dark theme selectors | Flatten and use CSS variables |
|
|
||||||
| **Minor** | ID selectors for styling | `styles.css:233-247` | Prefer class selectors |
|
|
||||||
|
|
||||||
**Code Example - Problematic specificity:**
|
|
||||||
```css
|
|
||||||
/* styles.css:14 - Avoid !important */
|
|
||||||
.hidden {
|
|
||||||
display: none !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* styles.css:397-431 - Deep nesting */
|
|
||||||
body.theme-dark #preview h1,
|
|
||||||
body.theme-dark [id^="preview-"] h1,
|
|
||||||
body.theme-dark .preview-content h1 {
|
|
||||||
color: #c9d1d9;
|
|
||||||
border-bottom-color: #21262d;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
/* Use utility class pattern */
|
|
||||||
[hidden] { display: none; }
|
|
||||||
|
|
||||||
/* Use CSS custom properties for theming */
|
|
||||||
.preview-content h1 {
|
|
||||||
color: var(--text-primary);
|
|
||||||
border-bottom-color: var(--border-color);
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Theme applies variables */
|
|
||||||
body.theme-dark {
|
|
||||||
--text-primary: #c9d1d9;
|
|
||||||
--border-color: #21262d;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3.3 Reusable Style Definitions
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Repeated button styles | Multiple files | Create button component classes |
|
|
||||||
| **Major** | Dialog styles duplicated | Export, batch, print preview dialogs | Create modal component |
|
|
||||||
| **Minor** | Similar form field styles scattered | Export dialog inputs | Create form component |
|
|
||||||
|
|
||||||
**Code Example - Duplicated button styles:**
|
|
||||||
```css
|
|
||||||
/* styles.css */
|
|
||||||
.toolbar button { /* button styles */ }
|
|
||||||
.tab-close { /* button styles */ }
|
|
||||||
.new-tab-button { /* button styles */ }
|
|
||||||
#export-dialog-close { /* button styles */ }
|
|
||||||
|
|
||||||
/* styles-sidebar.css */
|
|
||||||
.sidebar-icon { /* similar button styles */ }
|
|
||||||
.sidebar-panel-close { /* similar button styles */ }
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```css
|
|
||||||
/* Create button component system */
|
|
||||||
.btn {
|
|
||||||
display: inline-flex;
|
|
||||||
align-items: center;
|
|
||||||
justify-content: center;
|
|
||||||
border: none;
|
|
||||||
cursor: pointer;
|
|
||||||
transition: all var(--transition-fast);
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn--icon {
|
|
||||||
width: 32px;
|
|
||||||
height: 32px;
|
|
||||||
border-radius: var(--radius-md);
|
|
||||||
}
|
|
||||||
|
|
||||||
.btn--close {
|
|
||||||
font-size: 14px;
|
|
||||||
font-weight: bold;
|
|
||||||
border-radius: var(--radius-sm);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3.4 Documentation
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Minor** | Limited CSS documentation | All CSS files | Add section comments |
|
|
||||||
| **Minor** | No component documentation | Sidebar components | Add JSDoc-style comments |
|
|
||||||
| **Suggestion** | No design tokens documentation | CSS variables | Create tokens documentation |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 4. Performance Review
|
|
||||||
|
|
||||||
### 4.1 CSS Optimization
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | Large CSS files (105KB main, 78KB modern) | `styles.css`, `styles-modern.css` | Split into smaller modules |
|
|
||||||
| **Major** | Duplicate style definitions | Multiple files | Remove redundancies |
|
|
||||||
| **Minor** | Unused styles likely present | Theme variations | Audit and remove unused |
|
|
||||||
|
|
||||||
### 4.2 Asset Loading
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Major** | highlight.js CSS loaded synchronously | `index.html:14` | Load asynchronously or bundle |
|
|
||||||
| **Minor** | Font files could be preloaded | `fonts.css` | Add preload links in HTML |
|
|
||||||
| **Suggestion** | Consider CSS critical path | Above-the-fold styles | Inline critical CSS |
|
|
||||||
|
|
||||||
**Code Example - Sync stylesheet loading:**
|
|
||||||
```html
|
|
||||||
<!-- index.html:14 - Blocks rendering -->
|
|
||||||
<link rel="stylesheet" href="../node_modules/highlight.js/styles/default.css">
|
|
||||||
```
|
|
||||||
|
|
||||||
**Fix Recommendation:**
|
|
||||||
```html
|
|
||||||
<!-- Non-blocking load -->
|
|
||||||
<link rel="stylesheet" href="../node_modules/highlight.js/styles/default.css" media="print" onload="this.media='all'">
|
|
||||||
|
|
||||||
<!-- Or preload fonts -->
|
|
||||||
<link rel="preload" href="../assets/fonts/Inter-Regular.woff2" as="font" type="font/woff2" crossorigin>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4.3 Animation Performance
|
|
||||||
|
|
||||||
| Severity | Issue | Location | Recommendation |
|
|
||||||
|----------|-------|----------|----------------|
|
|
||||||
| **Minor** | Some transitions on expensive properties | `styles-modern.css:111-112` | Prefer transform/opacity |
|
|
||||||
| **Suggestion** | Missing will-change hints | Complex animations | Add will-change for GPU hints |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 5. Component-Specific Issues
|
|
||||||
|
|
||||||
### 5.1 Tab System
|
|
||||||
|
|
||||||
| File | Issues |
|
|
||||||
|------|--------|
|
|
||||||
| `styles.css:23-97` | Inconsistent active state styling, small close button |
|
|
||||||
| `renderer.js:88-346` | Tab content created via innerHTML (XSS risk) |
|
|
||||||
|
|
||||||
### 5.2 Sidebar
|
|
||||||
|
|
||||||
| File | Issues |
|
|
||||||
|------|--------|
|
|
||||||
| `styles-sidebar.css` | Good structure but missing focus states |
|
|
||||||
| `sidebar-manager.js` | Clean implementation, needs ARIA |
|
|
||||||
|
|
||||||
### 5.3 Export Dialogs
|
|
||||||
|
|
||||||
| File | Issues |
|
|
||||||
|------|--------|
|
|
||||||
| `styles.css:1060-1355` | Monolithic, should be component |
|
|
||||||
| `index.html:171-331` | Complex nested structure needs semantic HTML |
|
|
||||||
|
|
||||||
### 5.4 Welcome Screen
|
|
||||||
|
|
||||||
| File | Issues |
|
|
||||||
|------|--------|
|
|
||||||
| `styles-welcome.css` | Minimal styles, good foundation |
|
|
||||||
| Missing hover states for keyboard focus | Add :focus-visible |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 6. Prioritized Fix Recommendations
|
|
||||||
|
|
||||||
### Critical (Immediate)
|
|
||||||
|
|
||||||
1. **Add missing ARIA attributes** to all interactive elements
|
|
||||||
2. **Increase tab close button size** to minimum 24x24px
|
|
||||||
3. **Add focus-visible styles** for keyboard navigation
|
|
||||||
4. **Fix duplicate font-size declaration** in `.preview-content`
|
|
||||||
|
|
||||||
### Major (Next Sprint)
|
|
||||||
|
|
||||||
1. **Consolidate CSS resets** into single location
|
|
||||||
2. **Create button component system** with variants
|
|
||||||
3. **Standardize dark theme selectors** across all files
|
|
||||||
4. **Replace hardcoded colors** with CSS variables
|
|
||||||
5. **Create modal/dialog component** to reduce duplication
|
|
||||||
|
|
||||||
### Minor (Future)
|
|
||||||
|
|
||||||
1. **Document CSS architecture** and naming conventions
|
|
||||||
2. **Audit and remove unused styles**
|
|
||||||
3. **Add loading state components** (skeletons, spinners)
|
|
||||||
4. **Implement CSS module splitting** for better performance
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 7. Summary Statistics
|
|
||||||
|
|
||||||
| Category | Critical | Major | Minor | Suggestions |
|
|
||||||
|----------|----------|-------|-------|-------------|
|
|
||||||
| Visual Design | 1 | 5 | 4 | 1 |
|
|
||||||
| Usability | 3 | 4 | 4 | 0 |
|
|
||||||
| Code Quality | 0 | 6 | 4 | 1 |
|
|
||||||
| Performance | 0 | 3 | 2 | 2 |
|
|
||||||
| **Total** | **4** | **18** | **14** | **4** |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Conclusion
|
|
||||||
|
|
||||||
The MarkdownConverter application has a functional UI with good visual variety through its theme system. However, there are significant opportunities for improvement in:
|
|
||||||
|
|
||||||
1. **Accessibility** - Critical for users with disabilities
|
|
||||||
2. **Code organization** - Reduce CSS duplication and improve maintainability
|
|
||||||
3. **Component consistency** - Standardize interactive element sizing and states
|
|
||||||
4. **Performance** - Optimize CSS loading and reduce bundle size
|
|
||||||
|
|
||||||
Addressing the Critical and Major issues will significantly improve both user experience and code maintainability.
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
{
|
|
||||||
"review_id": "full-ui-review_20260315",
|
|
||||||
"target": "src/ (Entire UI Directory)",
|
|
||||||
"focus_areas": ["visual", "usability", "code", "performance"],
|
|
||||||
"context": "comprehensive",
|
|
||||||
"platform": "desktop",
|
|
||||||
"status": "complete",
|
|
||||||
"started_at": "2026-03-15T00:09:00.000Z",
|
|
||||||
"completed_at": "2026-03-15T00:12:00.000Z",
|
|
||||||
"issues_found": 40,
|
|
||||||
"severity_counts": {
|
|
||||||
"critical": 4,
|
|
||||||
"major": 18,
|
|
||||||
"minor": 14,
|
|
||||||
"suggestion": 4
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Vendored
-48
@@ -1,48 +0,0 @@
|
|||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "Debug Main Process",
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"cwd": "${workspaceFolder}",
|
|
||||||
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
|
|
||||||
"windows": {
|
|
||||||
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
|
|
||||||
},
|
|
||||||
"args": ["."],
|
|
||||||
"outputCapture": "std",
|
|
||||||
"env": {
|
|
||||||
"NODE_ENV": "development"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Debug Renderer Process",
|
|
||||||
"type": "chrome",
|
|
||||||
"request": "attach",
|
|
||||||
"port": 9222,
|
|
||||||
"webRoot": "${workspaceFolder}/src",
|
|
||||||
"timeout": 30000
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Debug Main + Renderer",
|
|
||||||
"type": "node",
|
|
||||||
"request": "launch",
|
|
||||||
"cwd": "${workspaceFolder}",
|
|
||||||
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
|
|
||||||
"windows": {
|
|
||||||
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron.cmd"
|
|
||||||
},
|
|
||||||
"args": [".", "--remote-debugging-port=9222"],
|
|
||||||
"outputCapture": "std",
|
|
||||||
"env": {
|
|
||||||
"NODE_ENV": "development"
|
|
||||||
},
|
|
||||||
"serverReadyAction": {
|
|
||||||
"pattern": "listening on port ([0-9]+)",
|
|
||||||
"uriFormat": "http://localhost:%s",
|
|
||||||
"action": "debugWithChrome"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
@@ -1,25 +0,0 @@
|
|||||||
# Repository Guidelines
|
|
||||||
|
|
||||||
## Project Structure & Module Organization
|
|
||||||
Core application code lives in `src/`. Use `src/main.js` for the Electron main process, `src/preload.js` for the preload bridge, and `src/renderer.js` plus `src/editor/`, `src/sidebar/`, `src/repl/`, and `src/utils/` for renderer-side features. Electron adapter code is in `src/adapters/electron/`. Reusable markdown/document templates live in `src/templates/`. Static assets and icons are in `assets/`. Tests are in `tests/`, and build output goes to `dist/`.
|
|
||||||
|
|
||||||
## Build, Test, and Development Commands
|
|
||||||
- `npm start`: launch the Electron app locally.
|
|
||||||
- `npm test`: run the Jest suite once.
|
|
||||||
- `npm run test:watch`: rerun tests during local development.
|
|
||||||
- `npm run test:coverage`: generate coverage output.
|
|
||||||
- `npm run lint` / `npm run lint:fix`: check or fix ESLint issues in `src` and `tests`.
|
|
||||||
- `npm run format` / `npm run format:check`: apply or verify Prettier formatting.
|
|
||||||
- `npm run build:linux`, `npm run build:win`, `npm run build:mac`: create platform packages with `electron-builder`.
|
|
||||||
|
|
||||||
## Coding Style & Naming Conventions
|
|
||||||
This repo uses Prettier and ESLint. Follow `.prettierrc`: 2-space indentation, single quotes, semicolons, trailing commas where valid in ES5, and a 100-character line width. Prefer `camelCase` for variables/functions, `PascalCase` for classes, and kebab-case for file names only when already established. Keep module boundaries clear: UI logic in renderer modules, OS/file-system work behind Electron IPC and adapters.
|
|
||||||
|
|
||||||
## Testing Guidelines
|
|
||||||
Tests use Jest with `jest-environment-jsdom`. Add new tests under `tests/` with `*.test.js` names, mirroring the feature area when possible, for example `tests/sidebar.test.js` or `tests/print-preview.test.js`. Update or add regression tests for renderer behavior, preload APIs, and utility helpers when fixing bugs. Run `npm test` before opening a PR; use `npm run test:coverage` for larger refactors.
|
|
||||||
|
|
||||||
## Commit & Pull Request Guidelines
|
|
||||||
Recent history follows Conventional Commit prefixes such as `feat:`, `fix:`, and `refactor:`. Keep subjects short and imperative, for example `fix: guard modal cleanup on close`. PRs should describe the user-visible change, note test coverage, link any related issue, and include screenshots or GIFs for UI changes.
|
|
||||||
|
|
||||||
## Security & Configuration Tips
|
|
||||||
Do not bypass preload boundaries or introduce direct `eval`/dynamic code paths; ESLint already treats these as errors. Export and conversion features depend on external tools such as Pandoc, FFmpeg, ImageMagick, and LibreOffice, so document any new runtime dependency in `README.md` and packaging config.
|
|
||||||
@@ -1,103 +0,0 @@
|
|||||||
# CLAUDE.md — MarkdownConverter (master)
|
|
||||||
|
|
||||||
> General code-quality, JavaScript, git, security, and testing standards are in the **global CLAUDE.md**. This file holds project- and branch-specific notes.
|
|
||||||
|
|
||||||
## Project Overview
|
|
||||||
|
|
||||||
Electron desktop app for Markdown editing and universal file conversion powered by Pandoc. Cross-platform (Win/macOS/Linux). Features: multi-tab editor with live preview, 25+ themes, PDF viewer/editor (merge/split/compress/rotate/watermark/password), export to 20+ formats (PDF/DOCX/ODT/EPUB/HTML/LaTeX/RTF/PPTX), batch conversion, syntax highlighting, diagram support (Mermaid), Git integration, and a plugin system.
|
|
||||||
|
|
||||||
- **Version:** 4.4.5
|
|
||||||
- **License:** MIT
|
|
||||||
- **App ID:** `com.concreteinfo.markdownconverter`
|
|
||||||
|
|
||||||
## Branch Specifics
|
|
||||||
|
|
||||||
This is the **primary/release branch** — a vanilla JavaScript Electron app with no bundler or framework in the renderer. The renderer is a single large `renderer.js` (5,300+ lines) loaded directly via `src/index.html`. All UI is hand-rolled DOM manipulation.
|
|
||||||
|
|
||||||
## Architecture
|
|
||||||
|
|
||||||
### Main Process (`src/main.js` — 4,260 lines)
|
|
||||||
Monolithic main process file. Contains all IPC handlers, Pandoc invocation, file operations, menu definitions (600+ lines), and window lifecycle. Key modules extracted:
|
|
||||||
- `src/main/PDFOperations.js` — PDF manipulation via `pdf-lib` (merge, split, compress, rotate, delete, reorder, watermark, encrypt, decrypt, permissions)
|
|
||||||
- `src/main/GitOperations.js` — Git status/stage/commit/log via `simple-git`
|
|
||||||
|
|
||||||
### Renderer (`src/renderer.js` — 5,361 lines)
|
|
||||||
Vanilla JS, no framework. Directly manipulates DOM. Loads CodeMirror 6 via `src/editor/codemirror-setup.js`. Uses `marked` + `highlight.js` + `DOMPurify` + `mermaid` for rendering. Lazy-loads sidebar panels, REPL, command palette, zen mode.
|
|
||||||
|
|
||||||
### Preload (`src/preload.js` — 448 lines)
|
|
||||||
Exists as IPC bridge, but **`contextIsolation: false` and `nodeIntegration: true`** — the renderer has full Node access. Preload is effectively a thin passthrough.
|
|
||||||
|
|
||||||
### Security Model
|
|
||||||
- `contextIsolation: false` + `nodeIntegration: true` (legacy; the react-electron branch fixes this)
|
|
||||||
- Pandoc invoked via `execFile` (not `exec`) to prevent shell injection
|
|
||||||
- Path traversal protection: `validatePath()`, `resolveWritablePath()`, blocks sensitive system dirs
|
|
||||||
- Permission handler only allows `clipboard-read`/`clipboard-write`
|
|
||||||
- Rate limiter on conversions (2-second minimum interval)
|
|
||||||
- File size limit: 50MB
|
|
||||||
- Error message sanitization strips absolute paths
|
|
||||||
|
|
||||||
### Plugin System (`src/plugins/`)
|
|
||||||
Manifest-based discovery (`manifest.json`). Built-in `writing-studio` plugin with sprint/goal/snapshot management. Plugin API exposed via `src/plugins/plugin-api.js`.
|
|
||||||
|
|
||||||
### Settings
|
|
||||||
Custom JSON file store at `<userData>/settings.json` (NOT `electron-store` despite the dependency). Recent files at `<userData>/recent-files.json`.
|
|
||||||
|
|
||||||
## System Dependencies
|
|
||||||
|
|
||||||
| Dependency | Required | Notes |
|
|
||||||
|---|---|---|
|
|
||||||
| **Node.js** | >= 20 | Electron 41 bundles Node 20.x |
|
|
||||||
| **Pandoc** | Yes (for exports) | Downloaded to `bin/<platform>/pandoc` via `scripts/download-tools.js` (v3.9.0.2). Falls back to system PATH. Must be present for DOCX/ODT/EPUB/LaTeX/PPTX export. |
|
|
||||||
| **FFmpeg** | Bundled | `ffmpeg-static` npm package; `asarUnpacked` for packaged builds |
|
|
||||||
| **MiKTeX / TeX Live** | Optional | For LaTeX PDF export; MiKTeX PATH injected on Windows automatically |
|
|
||||||
| **ImageMagick** | Optional | Linux image conversion; listed as deb dependency |
|
|
||||||
| **LibreOffice** | Optional | Enhanced document conversion; listed as deb dependency |
|
|
||||||
|
|
||||||
## Development Commands
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm start # Launch Electron app (dev mode)
|
|
||||||
npm test # Jest test suite
|
|
||||||
npm test:watch # Jest in watch mode
|
|
||||||
npm test:coverage # Jest with coverage report
|
|
||||||
npm run lint # ESLint check (src + tests)
|
|
||||||
npm run lint:fix # ESLint auto-fix
|
|
||||||
npm run format # Prettier write
|
|
||||||
npm run format:check # Prettier check only
|
|
||||||
npm run download-tools # Download Pandoc binaries to bin/
|
|
||||||
npm run generate-icons # Generate app icons via sharp
|
|
||||||
```
|
|
||||||
|
|
||||||
## Build & Package
|
|
||||||
|
|
||||||
**Tool:** `electron-builder` (v26.0.12), config inline in `package.json` (no separate config file).
|
|
||||||
|
|
||||||
| Target | Platforms |
|
|
||||||
|---|---|
|
|
||||||
| `npm run build` | electron-builder (default platform) |
|
|
||||||
| `npm run build:win` | Windows: NSIS installer + portable + zip (x64) |
|
|
||||||
| `npm run build:mac` | macOS: default dmg |
|
|
||||||
| `npm run build:linux` | Linux: deb + AppImage + snap |
|
|
||||||
| `npm run dist` | Build without publish |
|
|
||||||
| `npm run dist:all` | Build for all platforms |
|
|
||||||
|
|
||||||
**Bundled with builds:** Pandoc binary per platform. FFmpeg via `ffmpeg-static` (asarUnpacked). NSIS installer uses custom script at `scripts/nsis-installer.nsh`.
|
|
||||||
|
|
||||||
**Output:** `dist/` directory.
|
|
||||||
|
|
||||||
**CI:** GitHub Actions workflows in `.github/workflows/` (ci.yml, release.yml).
|
|
||||||
|
|
||||||
## Project Conventions / Gotchas
|
|
||||||
|
|
||||||
- **No bundler/transpilation.** The app uses vanilla CommonJS JavaScript. `src/main.js` is loaded directly by Electron. No webpack, no Vite, no TypeScript, no Babel.
|
|
||||||
- **Monolithic files.** `main.js` (4,260 lines) and `renderer.js` (5,361 lines) contain most logic. Not ideal but is the current state of this branch.
|
|
||||||
- **CodeMirror 6** for the editor, configured in `src/editor/codemirror-setup.js`.
|
|
||||||
- **PDF rendering** uses `pdfjs-dist`; **PDF manipulation** uses `pdf-lib` in the main process.
|
|
||||||
- **Renderer security is weak** — full Node access in renderer. Do NOT introduce new privileged renderer code without understanding this.
|
|
||||||
- **Pandoc is external.** Must be installed separately or downloaded via `npm run download-tools`. HTML and built-in PDF export work without Pandoc; other formats require it.
|
|
||||||
- **PDF export fallback chain:** xelatex -> pdflatex -> lualatex -> Electron built-in `printToPDF()`.
|
|
||||||
- **ESLint flat config** (`eslint.config.js`) with ECMAScript 2022. Prettier with 2-space indent, single quotes, semicolons, 100-char width.
|
|
||||||
- **Tests:** Jest with jsdom environment, 15% coverage threshold. 24 test files in `tests/`.
|
|
||||||
- **File associations:** `.md`, `.markdown`, `.pdf` registered at install.
|
|
||||||
- **Single instance lock** enforced via `app.requestSingleInstanceLock()`.
|
|
||||||
- **Adapters layer** (`src/adapters/`) abstracts file system operations for potential future non-Electron targets.
|
|
||||||
@@ -1,103 +0,0 @@
|
|||||||
# Export Functionality Fix - Summary
|
|
||||||
|
|
||||||
## Issues Found and Fixed
|
|
||||||
|
|
||||||
### 1. **Primary Issue: Pandoc Installation Problem**
|
|
||||||
- **Problem**: Pandoc is installed but has a system error (paging file too small)
|
|
||||||
- **Impact**: All pandoc-dependent exports (DOCX, LaTeX, etc.) were failing
|
|
||||||
- **Solution**: Added robust fallback mechanisms
|
|
||||||
|
|
||||||
### 2. **Export Function Improvements**
|
|
||||||
|
|
||||||
#### Before (Issues):
|
|
||||||
- ❌ No pandoc availability checking
|
|
||||||
- ❌ Poor error messages
|
|
||||||
- ❌ No fallback for missing pandoc
|
|
||||||
- ❌ Limited debugging information
|
|
||||||
|
|
||||||
#### After (Fixed):
|
|
||||||
- ✅ **Pandoc Detection**: Automatically checks if pandoc is available
|
|
||||||
- ✅ **Built-in HTML Export**: Works without pandoc using marked library
|
|
||||||
- ✅ **Built-in PDF Export**: Works without pandoc using Electron's printToPDF
|
|
||||||
- ✅ **Better Error Messages**: Clear instructions for users
|
|
||||||
- ✅ **Comprehensive Logging**: Debug information in console
|
|
||||||
- ✅ **Graceful Fallbacks**: Falls back to built-in converters when pandoc fails
|
|
||||||
|
|
||||||
## How It Works Now
|
|
||||||
|
|
||||||
### Export Process Flow:
|
|
||||||
1. **User clicks export** → Check if file is saved
|
|
||||||
2. **Select output location** → Show save dialog
|
|
||||||
3. **Check pandoc availability** → Async pandoc detection
|
|
||||||
4. **Choose export method**:
|
|
||||||
- **If pandoc available**: Use pandoc with format-specific options
|
|
||||||
- **If pandoc not available**:
|
|
||||||
- HTML → Use built-in marked converter
|
|
||||||
- PDF → Use Electron's printToPDF
|
|
||||||
- Other formats → Show helpful error with installation guide
|
|
||||||
|
|
||||||
### Supported Export Formats:
|
|
||||||
|
|
||||||
#### ✅ **Always Work** (no pandoc required):
|
|
||||||
- **HTML**: Built-in converter using marked library
|
|
||||||
- **PDF**: Built-in converter using Electron
|
|
||||||
|
|
||||||
#### ✅ **Work with Pandoc** (better quality):
|
|
||||||
- **DOCX**: Microsoft Word format
|
|
||||||
- **LaTeX**: LaTeX document
|
|
||||||
- **RTF**: Rich Text Format
|
|
||||||
- **ODT**: OpenDocument Text
|
|
||||||
- **EPUB**: E-book format
|
|
||||||
- **PPTX**: PowerPoint presentations
|
|
||||||
- **ODP**: OpenDocument Presentations
|
|
||||||
|
|
||||||
## Testing the Fixes
|
|
||||||
|
|
||||||
### Manual Test Procedure:
|
|
||||||
1. **Start the application**: `npm start`
|
|
||||||
2. **Open test file**: Load `test-export.md`
|
|
||||||
3. **Test HTML export**: File → Export → HTML (should work)
|
|
||||||
4. **Test PDF export**: File → Export → PDF (should work)
|
|
||||||
5. **Test DOCX export**: File → Export → DOCX (will show pandoc error)
|
|
||||||
|
|
||||||
### Expected Behavior:
|
|
||||||
- **HTML/PDF exports**: Should work immediately and create files
|
|
||||||
- **Other format exports**: Should show informative error about pandoc
|
|
||||||
- **Console logs**: Should show debug information about export process
|
|
||||||
|
|
||||||
## Fix Summary
|
|
||||||
|
|
||||||
### Code Changes Made:
|
|
||||||
1. **Added `checkPandocAvailability()` function** - Detects pandoc
|
|
||||||
2. **Added `exportToHTML()` function** - Built-in HTML export
|
|
||||||
3. **Added `exportToPDFElectron()` function** - Built-in PDF export
|
|
||||||
4. **Added `exportWithPandoc()` helper** - Generic pandoc export
|
|
||||||
5. **Added `exportWithPandocPDF()` helper** - PDF with fallbacks
|
|
||||||
6. **Improved `exportFile()` function** - Main export logic with detection
|
|
||||||
7. **Enhanced error handling** - Better user messages
|
|
||||||
8. **Added comprehensive logging** - Debug information
|
|
||||||
|
|
||||||
### Files Modified:
|
|
||||||
- `src/main.js` - Enhanced export functionality
|
|
||||||
- `test-export.md` - Created test file
|
|
||||||
- `test-export-functionality.js` - Created test script
|
|
||||||
|
|
||||||
## User Instructions
|
|
||||||
|
|
||||||
### For Users Without Pandoc:
|
|
||||||
- ✅ **HTML and PDF exports work perfectly**
|
|
||||||
- ✅ **No additional software needed**
|
|
||||||
- ✅ **Professional-looking output with proper styling**
|
|
||||||
|
|
||||||
### For Users Who Want All Formats:
|
|
||||||
1. **Install Pandoc**: Visit https://pandoc.org/installing.html
|
|
||||||
2. **For PDF with LaTeX**: Also install MiKTeX or TeX Live
|
|
||||||
3. **Restart the application** after installation
|
|
||||||
4. **All export formats will then be available**
|
|
||||||
|
|
||||||
## Result
|
|
||||||
🎉 **Export functionality is now working reliably!**
|
|
||||||
- Built-in exports (HTML, PDF) work without any dependencies
|
|
||||||
- Clear error messages guide users for advanced formats
|
|
||||||
- Robust error handling prevents crashes
|
|
||||||
- Better user experience with informative dialogs
|
|
||||||
@@ -1,82 +0,0 @@
|
|||||||
# GEMINI.md
|
|
||||||
|
|
||||||
## Project Overview
|
|
||||||
|
|
||||||
This project is a cross-platform Markdown editor and converter named **PanConverter**. It is built using the Electron framework, allowing it to run on Windows, macOS, and Linux. The application provides a rich text editor for writing Markdown, a live preview pane, and robust export capabilities powered by Pandoc.
|
|
||||||
|
|
||||||
The core technologies used are:
|
|
||||||
- **Electron:** For creating the desktop application.
|
|
||||||
- **JavaScript:** The primary programming language.
|
|
||||||
- **Pandoc:** For converting Markdown to various formats like PDF, DOCX, HTML, etc.
|
|
||||||
- **Marked:** For parsing and rendering the Markdown preview in real-time.
|
|
||||||
- **CodeMirror:** As the underlying text editor component.
|
|
||||||
- **highlight.js:** For syntax highlighting in the editor.
|
|
||||||
- **DOMPurify:** To sanitize the HTML output in the preview pane for security.
|
|
||||||
|
|
||||||
The application features a tabbed interface for working with multiple files, various themes, find and replace functionality, and detailed document statistics.
|
|
||||||
|
|
||||||
## Building and Running
|
|
||||||
|
|
||||||
To build and run this project locally, you will need to have Node.js and npm installed.
|
|
||||||
|
|
||||||
### Installation
|
|
||||||
|
|
||||||
1. **Clone the repository:**
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/amitwh/pan-converter.git
|
|
||||||
cd pan-converter
|
|
||||||
```
|
|
||||||
|
|
||||||
2. **Install dependencies:**
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### Running the Application
|
|
||||||
|
|
||||||
To run the application in development mode, use the following command:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
### Building the Application
|
|
||||||
|
|
||||||
You can build the application for different platforms using the scripts defined in `package.json`.
|
|
||||||
|
|
||||||
- **Build for the current platform:**
|
|
||||||
```bash
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
- **Build for a specific platform:**
|
|
||||||
```bash
|
|
||||||
npm run build:win # For Windows
|
|
||||||
npm run build:mac # For macOS
|
|
||||||
npm run build:linux # For Linux
|
|
||||||
```
|
|
||||||
|
|
||||||
- **Build for all platforms at once:**
|
|
||||||
```bash
|
|
||||||
npm run dist:all
|
|
||||||
```
|
|
||||||
|
|
||||||
The distributable files will be located in the `dist/` directory.
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
|
|
||||||
The project does not have a dedicated test suite configured. The `test` script in `package.json` currently returns an error.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
npm test
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development Conventions
|
|
||||||
|
|
||||||
- **Code Style:** The codebase is written in JavaScript (ES6+). There is no linter or formatter configured, but the code generally follows standard JavaScript conventions.
|
|
||||||
- **Main vs. Renderer Process:** The application logic is split between the Electron main process (`src/main.js`) and the renderer process (`src/renderer.js`).
|
|
||||||
- `src/main.js` handles window management, application menus, file system operations, and communication with the operating system.
|
|
||||||
- `src/renderer.js` manages the user interface, editor functionality, and the Markdown preview.
|
|
||||||
- **Dependencies:** Project dependencies are managed through `package.json`. `devDependencies` are used for the build process, while `dependencies` are required for the application to run.
|
|
||||||
- **User Data:** The application stores settings and recent files in the user's application data directory.
|
|
||||||
- **Pandoc Integration:** The application relies on a system-installed version of Pandoc for its export functionality. It does not bundle Pandoc.
|
|
||||||
-1478
File diff suppressed because it is too large
Load Diff
@@ -1,21 +1,674 @@
|
|||||||
MIT License
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
Copyright (c) 2024 Amit Haridas
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Preamble
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all
|
The GNU General Public License is a free, copyleft license for
|
||||||
copies or substantial portions of the Software.
|
software and other kinds of works.
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
The licenses for most software and other practical works are designed
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
to take away your freedom to share and change the works. By contrast,
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
share and change all versions of a program--to make sure it remains free
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
GNU General Public License for most of our software; it applies also to
|
||||||
SOFTWARE.
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
|
|||||||
@@ -1,12 +0,0 @@
|
|||||||
# Test Double-Click File Opening
|
|
||||||
|
|
||||||
This is a test file to verify double-click functionality.
|
|
||||||
|
|
||||||
## Features to Test
|
|
||||||
- File should load automatically
|
|
||||||
- Content should display in editor
|
|
||||||
- Tab should show filename
|
|
||||||
- Preview should render markdown
|
|
||||||
|
|
||||||
**This text should be bold**
|
|
||||||
*This text should be italic*
|
|
||||||
-378
@@ -1,378 +0,0 @@
|
|||||||
\hypertarget{panconverter}{%
|
|
||||||
\section{PanConverter}\label{panconverter}}
|
|
||||||
|
|
||||||
A cross-platform Markdown editor and converter powered by Pandoc.
|
|
||||||
|
|
||||||
\begin{figure}
|
|
||||||
\centering
|
|
||||||
\includegraphics{assets/icon.png}
|
|
||||||
\caption{PanConverter}
|
|
||||||
\end{figure}
|
|
||||||
|
|
||||||
\hypertarget{features}{%
|
|
||||||
\subsection{Features}\label{features}}
|
|
||||||
|
|
||||||
\hypertarget{advanced-markdown-editor}{%
|
|
||||||
\subsubsection{✨ Advanced Markdown
|
|
||||||
Editor}\label{advanced-markdown-editor}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
🗂️ \textbf{Tabbed Interface} - Work with multiple files simultaneously
|
|
||||||
in separate tabs
|
|
||||||
\item
|
|
||||||
📝 \textbf{Rich Text Editor} - Full-featured editor with syntax
|
|
||||||
highlighting and comprehensive toolbar
|
|
||||||
\item
|
|
||||||
🔍 \textbf{Find \& Replace} - Powerful search and replace with match
|
|
||||||
highlighting and navigation
|
|
||||||
\item
|
|
||||||
🔢 \textbf{Line Numbers} - Toggle line numbers for easier code editing
|
|
||||||
and navigation
|
|
||||||
\item
|
|
||||||
↩️ \textbf{Smart Auto-Indentation} - Automatic list continuation and
|
|
||||||
intelligent indentation
|
|
||||||
\item
|
|
||||||
⏪ \textbf{Undo/Redo} - Full undo/redo support with keyboard shortcuts
|
|
||||||
\item
|
|
||||||
⌨️ \textbf{Advanced Shortcuts} - Tab indentation, line selection, and
|
|
||||||
smart text formatting
|
|
||||||
\item
|
|
||||||
📂 \textbf{File Association Support} - Open markdown files directly
|
|
||||||
from file manager
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{themes-interface}{%
|
|
||||||
\subsubsection{🎨 Themes \& Interface}\label{themes-interface}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
👁️ \textbf{Live Preview} - See your markdown rendered in real-time
|
|
||||||
with synchronized scrolling
|
|
||||||
\item
|
|
||||||
🎨 \textbf{Multiple Themes} - Choose from Light, Dark, Solarized,
|
|
||||||
Monokai, or GitHub themes
|
|
||||||
\item
|
|
||||||
💾 \textbf{Auto-Save} - Never lose your work with automatic saving
|
|
||||||
every 30 seconds
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{export-conversion}{%
|
|
||||||
\subsubsection{📤 Export \& Conversion}\label{export-conversion}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
📄 \textbf{Enhanced PDF Export} - Robust PDF generation with multiple
|
|
||||||
LaTeX engine fallbacks (XeLaTeX, PDFLaTeX, wkhtmltopdf)
|
|
||||||
\item
|
|
||||||
📄 \textbf{Document Export} - Convert to HTML, DOCX, LaTeX, RTF, ODT,
|
|
||||||
EPUB, PowerPoint (PPTX), and OpenDocument Presentation (ODP)
|
|
||||||
\item
|
|
||||||
📊 \textbf{Spreadsheet Export} - Export markdown tables to Excel
|
|
||||||
(XLSX/XLS) and OpenDocument Spreadsheet (ODS) formats
|
|
||||||
\item
|
|
||||||
📥 \textbf{Document Import} - Import DOCX, ODT, RTF, HTML, PDF, and
|
|
||||||
presentation files to markdown
|
|
||||||
\item
|
|
||||||
📋 \textbf{Table Creation Helper} - Built-in table generator for easy
|
|
||||||
markdown table creation
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{platform-support}{%
|
|
||||||
\subsubsection{🖥️ Platform Support}\label{platform-support}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\textbf{Cross-Platform} - Works seamlessly on Windows, macOS, and
|
|
||||||
Linux
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{installation}{%
|
|
||||||
\subsection{Installation}\label{installation}}
|
|
||||||
|
|
||||||
\hypertarget{prerequisites}{%
|
|
||||||
\subsubsection{Prerequisites}\label{prerequisites}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\href{https://pandoc.org/installing.html}{Pandoc} must be installed
|
|
||||||
for export functionality
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\textbf{Ubuntu/Debian}: \texttt{sudo\ apt-get\ install\ pandoc}
|
|
||||||
\item
|
|
||||||
\textbf{macOS}: \texttt{brew\ install\ pandoc}
|
|
||||||
\item
|
|
||||||
\textbf{Windows}: Download installer from Pandoc website
|
|
||||||
\end{itemize}
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{pdf-export-requirements}{%
|
|
||||||
\subsubsection{PDF Export Requirements}\label{pdf-export-requirements}}
|
|
||||||
|
|
||||||
For optimal PDF export, install a LaTeX engine (recommended): -
|
|
||||||
\textbf{Ubuntu/Debian}:
|
|
||||||
\texttt{sudo\ apt-get\ install\ texlive-xetex\ texlive-latex-base} -
|
|
||||||
\textbf{macOS}: \texttt{brew\ install\ -\/-cask\ mactex} -
|
|
||||||
\textbf{Windows}: Install MiKTeX or TeX Live - \textbf{Alternative}:
|
|
||||||
\texttt{sudo\ apt-get\ install\ wkhtmltopdf} (fallback option)
|
|
||||||
|
|
||||||
\hypertarget{download}{%
|
|
||||||
\subsubsection{Download}\label{download}}
|
|
||||||
|
|
||||||
Download the latest release for your platform from the
|
|
||||||
\href{https://github.com/amitwh/pan-converter/releases}{Releases} page.
|
|
||||||
|
|
||||||
\hypertarget{linux}{%
|
|
||||||
\paragraph{Linux}\label{linux}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\textbf{AppImage}: \texttt{PanConverter-1.3.1.AppImage} (universal,
|
|
||||||
may require \texttt{-\/-no-sandbox} flag)
|
|
||||||
\item
|
|
||||||
\textbf{Debian Package}: \texttt{pan-converter\_1.3.1\_amd64.deb}
|
|
||||||
\item
|
|
||||||
\textbf{Snap Package}: \texttt{pan-converter\_1.3.1\_amd64.snap}
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{install-from-source}{%
|
|
||||||
\subsubsection{Install from Source}\label{install-from-source}}
|
|
||||||
|
|
||||||
\begin{Shaded}
|
|
||||||
\begin{Highlighting}[]
|
|
||||||
\FunctionTok{git}\NormalTok{ clone https://github.com/amitwh/pan{-}converter.git}
|
|
||||||
\BuiltInTok{cd}\NormalTok{ pan{-}converter}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ install}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ start}
|
|
||||||
\end{Highlighting}
|
|
||||||
\end{Shaded}
|
|
||||||
|
|
||||||
\hypertarget{usage}{%
|
|
||||||
\subsection{Usage}\label{usage}}
|
|
||||||
|
|
||||||
\hypertarget{basic-workflow}{%
|
|
||||||
\subsubsection{Basic Workflow}\label{basic-workflow}}
|
|
||||||
|
|
||||||
\begin{enumerate}
|
|
||||||
\def\labelenumi{\arabic{enumi}.}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\textbf{Write} - Use the editor to write your Markdown content
|
|
||||||
\item
|
|
||||||
\textbf{Preview} - Toggle the preview pane to see rendered output
|
|
||||||
\item
|
|
||||||
\textbf{Theme} - Choose your preferred theme from the View menu
|
|
||||||
\item
|
|
||||||
\textbf{Export} - Export your document to various formats
|
|
||||||
\end{enumerate}
|
|
||||||
|
|
||||||
\hypertarget{export-options}{%
|
|
||||||
\subsubsection{Export Options}\label{export-options}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\textbf{Documents}: HTML, PDF, DOCX, LaTeX, RTF, ODT, EPUB
|
|
||||||
\item
|
|
||||||
\textbf{Presentations}: PowerPoint (PPTX), OpenDocument Presentation
|
|
||||||
(ODP)
|
|
||||||
\item
|
|
||||||
\textbf{Spreadsheets}: Excel (XLSX/XLS), OpenDocument Spreadsheet
|
|
||||||
(ODS)
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{import-conversion}{%
|
|
||||||
\subsubsection{Import \& Conversion}\label{import-conversion}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\textbf{Import Documents}: Convert DOCX, ODT, RTF, HTML, PDF, and
|
|
||||||
presentation files to Markdown
|
|
||||||
\item
|
|
||||||
\textbf{Cross-Format Conversion}: Convert current file between
|
|
||||||
multiple formats
|
|
||||||
\item
|
|
||||||
\textbf{Smart Presentation Handling}: Automatic slide-level formatting
|
|
||||||
for PPTX/ODP exports
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{table-creation}{%
|
|
||||||
\subsubsection{Table Creation}\label{table-creation}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
Click the table button in the toolbar
|
|
||||||
\item
|
|
||||||
Specify number of rows and columns
|
|
||||||
\item
|
|
||||||
Automatically generates properly formatted Markdown tables
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{keyboard-shortcuts}{%
|
|
||||||
\subsection{Keyboard Shortcuts}\label{keyboard-shortcuts}}
|
|
||||||
|
|
||||||
\hypertarget{file-operations}{%
|
|
||||||
\subsubsection{File Operations}\label{file-operations}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ N} - New file/tab
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ T} - New tab
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ W} - Close current tab
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ Tab} - Switch to next tab
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ O} - Open file
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ S} - Save file
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ Shift\ +\ S} - Save as
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ I} - Import document
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{editor-features}{%
|
|
||||||
\subsubsection{Editor Features}\label{editor-features}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ F} - Find \& Replace
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ Z} - Undo
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ Shift\ +\ Z} - Redo
|
|
||||||
\item
|
|
||||||
\texttt{Tab} - Indent lines or insert 4 spaces
|
|
||||||
\item
|
|
||||||
\texttt{Shift\ +\ Tab} - Outdent selected lines
|
|
||||||
\item
|
|
||||||
\texttt{Enter} - Auto-continue lists with proper indentation
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{view-navigation}{%
|
|
||||||
\subsubsection{View \& Navigation}\label{view-navigation}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ P} - Toggle preview
|
|
||||||
\item
|
|
||||||
\texttt{Ctrl/Cmd\ +\ Enter} - Toggle preview (alternative)
|
|
||||||
\item
|
|
||||||
\texttt{Escape} - Close find dialog
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{building}{%
|
|
||||||
\subsection{Building}\label{building}}
|
|
||||||
|
|
||||||
\begin{Shaded}
|
|
||||||
\begin{Highlighting}[]
|
|
||||||
\CommentTok{\# Install dependencies}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ install}
|
|
||||||
|
|
||||||
\CommentTok{\# Generate icons}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ run generate{-}icons}
|
|
||||||
|
|
||||||
\CommentTok{\# Build for current platform}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ run build}
|
|
||||||
|
|
||||||
\CommentTok{\# Build for specific platform}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ run build:win }\CommentTok{\# Windows}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ run build:mac }\CommentTok{\# macOS }
|
|
||||||
\ExtensionTok{npm}\NormalTok{ run build:linux }\CommentTok{\# Linux (generates .deb, .AppImage, and .snap)}
|
|
||||||
|
|
||||||
\CommentTok{\# Build for all platforms}
|
|
||||||
\ExtensionTok{npm}\NormalTok{ run dist:all}
|
|
||||||
\end{Highlighting}
|
|
||||||
\end{Shaded}
|
|
||||||
|
|
||||||
\hypertarget{version-history}{%
|
|
||||||
\subsection{Version History}\label{version-history}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
\textbf{v1.3.1} - Bug fixes: Fixed file associations for
|
|
||||||
double-clicking .md files, corrected 50/50 layout alignment for
|
|
||||||
editor/preview panes
|
|
||||||
\item
|
|
||||||
\textbf{v1.3.0} - Major update: Tabbed interface for multiple files,
|
|
||||||
enhanced PDF export with LaTeX engines, fixed file associations,
|
|
||||||
removed redundant converter menu, improved UI architecture
|
|
||||||
\item
|
|
||||||
\textbf{v1.2.1} - Comprehensive editor enhancements: Find \& Replace,
|
|
||||||
Line Numbers, Undo/Redo, Auto-indentation, PowerPoint export, document
|
|
||||||
conversion menu, table creation helper, spreadsheet export
|
|
||||||
\item
|
|
||||||
\textbf{v1.1.0} - Added Excel/ODS spreadsheet export, updated author
|
|
||||||
information, renamed to PanConverter
|
|
||||||
\item
|
|
||||||
\textbf{v1.0.0} - Initial release with basic markdown editing, themes,
|
|
||||||
and Pandoc export
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{known-issues}{%
|
|
||||||
\subsection{Known Issues}\label{known-issues}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
AppImage may require \texttt{-\/-no-sandbox} flag on some Linux
|
|
||||||
systems
|
|
||||||
\item
|
|
||||||
Windows/Mac builds require platform-specific build environments
|
|
||||||
\item
|
|
||||||
Large files may cause performance issues
|
|
||||||
\end{itemize}
|
|
||||||
|
|
||||||
\hypertarget{contributing}{%
|
|
||||||
\subsection{Contributing}\label{contributing}}
|
|
||||||
|
|
||||||
Contributions are welcome! Please feel free to submit a Pull Request to
|
|
||||||
the \href{https://github.com/amitwh/pan-converter}{GitHub repository}.
|
|
||||||
|
|
||||||
\hypertarget{license}{%
|
|
||||||
\subsection{License}\label{license}}
|
|
||||||
|
|
||||||
MIT License - see LICENSE file for details.
|
|
||||||
|
|
||||||
\hypertarget{author}{%
|
|
||||||
\subsection{Author}\label{author}}
|
|
||||||
|
|
||||||
\textbf{Amit Haridas} -
|
|
||||||
\href{mailto:amit.wh@gmail.com}{\nolinkurl{amit.wh@gmail.com}}
|
|
||||||
|
|
||||||
\hypertarget{acknowledgments}{%
|
|
||||||
\subsection{Acknowledgments}\label{acknowledgments}}
|
|
||||||
|
|
||||||
\begin{itemize}
|
|
||||||
\tightlist
|
|
||||||
\item
|
|
||||||
Built with \href{https://www.electronjs.org/}{Electron}
|
|
||||||
\item
|
|
||||||
Markdown parsing by \href{https://marked.js.org/}{marked}
|
|
||||||
\item
|
|
||||||
Export functionality powered by \href{https://pandoc.org/}{Pandoc}
|
|
||||||
\item
|
|
||||||
Syntax highlighting by \href{https://highlightjs.org/}{highlight.js}
|
|
||||||
\item
|
|
||||||
Spreadsheet export by \href{https://www.npmjs.com/package/xlsx}{XLSX}
|
|
||||||
\item
|
|
||||||
HTML sanitization by
|
|
||||||
\href{https://www.npmjs.com/package/dompurify}{DOMPurify}
|
|
||||||
\end{itemize}
|
|
||||||
@@ -1,223 +0,0 @@
|
|||||||
# MarkdownConverter
|
|
||||||
|
|
||||||
A powerful cross-platform Markdown editor and document converter powered by Pandoc, built with Electron. 100% open-source with no proprietary dependencies.
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
### Markdown Editor
|
|
||||||
<img width="1920" height="1032" alt="image" src="https://github.com/user-attachments/assets/5f53ba94-7663-47c3-b12b-b7b8bd2645aa" />
|
|
||||||
- **Multi-tab editing** - Work on multiple files simultaneously
|
|
||||||
- **Live preview** - Real-time markdown rendering with syntax highlighting
|
|
||||||
- **Dynamic splitter** - Drag to resize editor and preview panes
|
|
||||||
- **25+ themes** - Light and dark themes including Atom One Light, Dracula, Nord, Sepia, and more
|
|
||||||
- **Find & Replace** - Search and replace with regex support
|
|
||||||
- **Line numbers** - Toggle line numbers in the editor
|
|
||||||
- **Auto-save** - Automatic saving every 30 seconds
|
|
||||||
- **Math support** - KaTeX integration for mathematical expressions
|
|
||||||
|
|
||||||
### PDF Viewer & Editor
|
|
||||||
<img width="1920" height="1032" alt="image" src="https://github.com/user-attachments/assets/f10f62be-af3d-496e-81df-37ab4f91abfd" />
|
|
||||||
|
|
||||||
- **Built-in PDF viewer** - Open and view PDF files directly in the app
|
|
||||||
- **Page navigation** - Navigate pages with keyboard or buttons
|
|
||||||
- **Zoom controls** - Zoom in/out, fit to width, fit to page
|
|
||||||
- **Rotation** - Rotate pages left or right
|
|
||||||
- **PDF Editor tools**:
|
|
||||||
- Merge multiple PDFs
|
|
||||||
- Split PDFs by page range
|
|
||||||
- Compress PDFs
|
|
||||||
- Rotate pages
|
|
||||||
- Delete pages
|
|
||||||
- Reorder pages
|
|
||||||
- Add watermarks
|
|
||||||
- Password protection
|
|
||||||
- Remove passwords
|
|
||||||
- Set permissions
|
|
||||||
|
|
||||||
### Export Options
|
|
||||||
- **PDF** - Export to PDF with customizable page sizes and orientation
|
|
||||||
- **DOCX** - Standard and Enhanced (template-based) Word export
|
|
||||||
- **ODT** - OpenDocument format
|
|
||||||
- **HTML** - Web-ready HTML export
|
|
||||||
- **PowerPoint** - PPTX presentation export
|
|
||||||
- **EPUB** - E-book format
|
|
||||||
- **LaTeX** - Academic document format
|
|
||||||
- **RTF** - Rich Text Format
|
|
||||||
|
|
||||||
### Advanced Features
|
|
||||||
- **Custom headers & footers** - Add headers/footers to exports with dynamic fields
|
|
||||||
- **Page size configuration** - A3, A4, A5, B4, B5, Letter, Legal, Tabloid, or custom sizes
|
|
||||||
- **Batch conversion** - Convert entire folders of markdown files
|
|
||||||
- **ASCII Art Generator** - Create text banners and diagrams
|
|
||||||
- **Word templates** - Use custom Word templates for enhanced exports
|
|
||||||
- **Import documents** - Import from 30+ formats (DOCX, PDF, HTML, etc.)
|
|
||||||
- **MarkItDown import** - Any file → Markdown via [Microsoft MarkItDown](https://github.com/microsoft/markitdown): PDF, DOCX, PPTX, XLSX, Outlook .msg, EPUB, images, ZIP (audio/OCR with the `[all]` extras)
|
|
||||||
- **Excel export** - Markdown tables to native .xlsx workbooks (one sheet per table)
|
|
||||||
- **AI Assistant** - Multi-provider AI help (OpenAI/Anthropic/Ollama/LM Studio): chat panel, summarize/improve/translate commands, grammar proofreading
|
|
||||||
- **Inline comments** - Anchor-based document comments in `.comments/` sidecars with F8 navigation
|
|
||||||
- **Wiki-links & Backlinks** - `[[Note]]` links with click-to-create and a "what links here?" panel (local knowledge base)
|
|
||||||
- **Crash recovery** - Session restore of open tabs and unsaved buffers after a crash
|
|
||||||
- **Version history** - Automatic pre-save snapshots with restore/diff/delete from the History panel
|
|
||||||
- **Vim mode & snippet expansion** - Vim keybindings toggle; Tab expands saved snippets
|
|
||||||
- **Quick Note** - Global scratchpad (Ctrl+Alt+Q) that appends to `notes/quick-notes.md`
|
|
||||||
- **Real PDF encryption** - Password protection, removal, and permissions actually work
|
|
||||||
- **Offline math & diagrams** - KaTeX bundled locally; PlantUML renders locally when the CLI is installed
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
- [Node.js](https://nodejs.org/) (v16 or later)
|
|
||||||
- [Pandoc](https://pandoc.org/installing.html) (required for export functionality)
|
|
||||||
- Optional: [MarkItDown](https://github.com/microsoft/markitdown) (`pip install "markitdown[all]"`) for any-file → Markdown import
|
|
||||||
|
|
||||||
### Install Dependencies
|
|
||||||
```bash
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
### Run the Application
|
|
||||||
```bash
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
### Build for Distribution
|
|
||||||
```bash
|
|
||||||
# Windows
|
|
||||||
npm run build:win
|
|
||||||
|
|
||||||
# macOS
|
|
||||||
npm run build:mac
|
|
||||||
|
|
||||||
# Linux
|
|
||||||
npm run build:linux
|
|
||||||
```
|
|
||||||
|
|
||||||
## Keyboard Shortcuts
|
|
||||||
|
|
||||||
| Action | Shortcut |
|
|
||||||
|--------|----------|
|
|
||||||
| New File | Ctrl+N |
|
|
||||||
| Open File | Ctrl+O |
|
|
||||||
| Open PDF | Ctrl+Shift+O |
|
|
||||||
| Save | Ctrl+S |
|
|
||||||
| Save As | Ctrl+Shift+S |
|
|
||||||
| Export | Ctrl+E |
|
|
||||||
| Print | Ctrl+P |
|
|
||||||
| Find | Ctrl+F |
|
|
||||||
| Undo | Ctrl+Z |
|
|
||||||
| Redo | Ctrl+Shift+Z |
|
|
||||||
| New Tab | Ctrl+T |
|
|
||||||
| Close Tab | Ctrl+W |
|
|
||||||
| Toggle Preview | Ctrl+Shift+V |
|
|
||||||
| Zoom In | Ctrl+Shift++ |
|
|
||||||
| Zoom Out | Ctrl+Shift+- |
|
|
||||||
| Command Palette | Ctrl+Shift+P |
|
|
||||||
| Zen Mode | F11 |
|
|
||||||
| Writing Analytics | Ctrl+Shift+A |
|
|
||||||
| Quick Note | Ctrl+Alt+Q |
|
|
||||||
| Universal Converter | Ctrl+Shift+C |
|
|
||||||
| Table Generator | Ctrl+Shift+T |
|
|
||||||
| ASCII Art Generator | Ctrl+Shift+A |
|
|
||||||
| Next Comment | F8 |
|
|
||||||
| Add Comment at Cursor | Ctrl+Alt+M |
|
|
||||||
|
|
||||||
## Themes
|
|
||||||
|
|
||||||
### Light Themes
|
|
||||||
- Atom One Light (Default)
|
|
||||||
- GitHub Light
|
|
||||||
- Light
|
|
||||||
- Solarized Light
|
|
||||||
- Gruvbox Light
|
|
||||||
- Ayu Light
|
|
||||||
- Sepia
|
|
||||||
- Paper
|
|
||||||
- Rose Pine Dawn
|
|
||||||
- Concrete Light
|
|
||||||
|
|
||||||
### Dark Themes
|
|
||||||
- Dark
|
|
||||||
- One Dark
|
|
||||||
- Dracula
|
|
||||||
- Nord
|
|
||||||
- Monokai
|
|
||||||
- Material
|
|
||||||
- Gruvbox Dark
|
|
||||||
- Tokyo Night
|
|
||||||
- Palenight
|
|
||||||
- Ayu Dark
|
|
||||||
- Ayu Mirage
|
|
||||||
- Oceanic Next
|
|
||||||
- Cobalt2
|
|
||||||
- Concrete Dark
|
|
||||||
- Concrete Warm
|
|
||||||
|
|
||||||
## PDF Viewer
|
|
||||||
|
|
||||||
Open PDF files directly in MarkdownConverter:
|
|
||||||
- **File > Open PDF** or **Ctrl+Shift+O**
|
|
||||||
- Navigate pages with arrow buttons or page input
|
|
||||||
- Zoom controls: +/- buttons, Fit Width, Fit Page
|
|
||||||
- Rotate pages left or right
|
|
||||||
- Close PDF to return to editor
|
|
||||||
|
|
||||||
## Bundled Dependencies, Legal Notices & Credits
|
|
||||||
|
|
||||||
MarkdownConverter ships as a self-contained package. Everything needed for the
|
|
||||||
core workflows is **bundled**; a few large optional tools are detected from
|
|
||||||
the system when present.
|
|
||||||
|
|
||||||
### Bundled with the app
|
|
||||||
|
|
||||||
| Component | License | Role |
|
|
||||||
|---|---|---|
|
|
||||||
| [Pandoc](https://pandoc.org) 3.9 | GPL-2.0+ (separate process) | 25+ export/import formats |
|
|
||||||
| [FFmpeg](https://ffmpeg.org) (via ffmpeg-static) | GPL-3.0+ build (separate process) | audio/video tools |
|
|
||||||
| [MarkItDown](https://github.com/microsoft/markitdown) (MIT) + embedded Python runtime (PSF) | MIT / PSF | any-file → Markdown import (PDF/DOCX/PPTX/XLSX/Outlook/EPUB/images/ZIP) |
|
|
||||||
| [sharp](https://sharp.pixelplumbing.com) + libvips | Apache-2.0 / LGPL-2.1+ (dynamic) | image tools |
|
|
||||||
| [KaTeX](https://katex.org), [marked](https://marked.js.org), [highlight.js], [DOMPurify], [mermaid], [CodeMirror 6], pdf-lib (@cantoo fork), pdfjs-dist, JSZip, simple-git | MIT / Apache-2.0 / BSD-3 / MPL-2.0 | editor, preview, PDF, Git |
|
|
||||||
| JetBrains Mono & Fira Code fonts | SIL OFL 1.1 | editor typography |
|
|
||||||
|
|
||||||
GPL-licensed tools run as **separate processes** (never linked into the app)
|
|
||||||
and their complete corresponding sources are offered in
|
|
||||||
[SOURCES.md](SOURCES.md). Full details: [THIRD-PARTY-NOTICES.md](THIRD-PARTY-NOTICES.md),
|
|
||||||
also available inside the app under **Help → Third-Party Notices & Licenses**.
|
|
||||||
|
|
||||||
### Not bundled (used when installed)
|
|
||||||
|
|
||||||
LibreOffice (Office conversion), MiKTeX/TeX Live (LaTeX PDF), ImageMagick
|
|
||||||
(extra image formats), PlantUML + Java (local diagrams), Calibre (MOBI),
|
|
||||||
MarkItDown `[all]` extras (audio transcription / OCR).
|
|
||||||
|
|
||||||
### Credits
|
|
||||||
|
|
||||||
Built on open source: [Electron], [CodeMirror], [marked], [KaTeX],
|
|
||||||
[highlight.js], [DOMPurify](https://github.com/cure53/DOMPurify),
|
|
||||||
[mermaid](https://mermaid.js.org), [pdf-lib], [pdf.js](https://mozilla.github.io/pdf.js/),
|
|
||||||
[sharp]/libvips, [Pandoc], [FFmpeg], [MarkItDown] by Microsoft,
|
|
||||||
[simple-git], [JSZip], [JetBrains Mono], [Fira Code]. Thank you to all their
|
|
||||||
authors and maintainers.
|
|
||||||
|
|
||||||
## Open Source
|
|
||||||
|
|
||||||
MarkdownConverter is 100% open-source. All dependencies are permissively licensed:
|
|
||||||
- **Electron** - MIT License
|
|
||||||
- **pdf-lib** - MIT License
|
|
||||||
- **pdfjs-dist** - Apache 2.0 License
|
|
||||||
- **marked** - MIT License
|
|
||||||
- **highlight.js** - BSD 3-Clause License
|
|
||||||
- **dompurify** - Apache 2.0/MIT License
|
|
||||||
- **docx** - MIT License
|
|
||||||
- **xlsx** - Apache 2.0 License (SheetJS Community Edition)
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
MIT License - see LICENSE file for details.
|
|
||||||
|
|
||||||
## Author
|
|
||||||
|
|
||||||
Amit Haridas (amit.wh@gmail.com)
|
|
||||||
|
|
||||||
## Version
|
|
||||||
|
|
||||||
v4.7.0
|
|
||||||
-55
@@ -1,55 +0,0 @@
|
|||||||
# Source Code Availability (GPL / LGPL Written Offer)
|
|
||||||
|
|
||||||
MarkdownConverter distributes the following binaries built from GPL-licensed
|
|
||||||
software. Per GPL §3(b), this document is the written offer: **corresponding
|
|
||||||
source code for the exact versions listed below is available on request for
|
|
||||||
at least three years from each release**, and permanently at the referenced
|
|
||||||
public locations. Write to: amit.wh@gmail.com (or open a GitHub issue at
|
|
||||||
https://github.com/amitwh/markdown-converter/issues).
|
|
||||||
|
|
||||||
## Pandoc — GPL-2.0-or-later
|
|
||||||
|
|
||||||
- Binary shipped: `bin/pandoc` (v3.9.0.2, official upstream release, unmodified)
|
|
||||||
- SHA-256 (linux): `7d124235998ecd3cdd9a463b1e5f6691a178b6461824c29a36170a0882f05597`
|
|
||||||
- Source: <https://github.com/jgm/pandoc/archive/refs/tags/3.9.0.2.tar.gz>
|
|
||||||
- Pandoc statically links Haskell libraries (GHC ecosystem, mostly BSD-3);
|
|
||||||
their sources are included in the upstream release tarball's dependency set.
|
|
||||||
|
|
||||||
## FFmpeg — GPL-3.0-or-later (build configuration)
|
|
||||||
|
|
||||||
- Binary shipped: `ffmpeg` provided by the npm package `ffmpeg-static@5.3.0`
|
|
||||||
(Linux: johnvansickle.com build; Windows: gyan.dev; macOS: evermeet.cx —
|
|
||||||
all `--enable-gpl` builds including x264/x265, per the build banner)
|
|
||||||
- Source:
|
|
||||||
- FFmpeg: <https://ffmpeg.org/releases/> (use the release matching
|
|
||||||
`ffmpeg -version` of the shipped binary)
|
|
||||||
- Build scripts & pinned versions: <https://github.com/eugeneware/ffmpeg-static>
|
|
||||||
- x264: <https://code.videolan.org/videolan/x264> ·
|
|
||||||
x265: <https://bitbucket.org/multicoreware/x265_git/> ·
|
|
||||||
other `--enable-lib*` components: their upstream sources (all free/open)
|
|
||||||
|
|
||||||
## PyInstaller bootloader (inside the bundled MarkItDown binary) — GPL-2.0 with boot-exception
|
|
||||||
|
|
||||||
- Binary shipped: `bin/markitdown` (MarkItDown 0.1.7 frozen with PyInstaller 6.x)
|
|
||||||
- PyInstaller grants a special exception allowing the bootloader to be
|
|
||||||
embedded in non-GPL frozen applications; source anyway:
|
|
||||||
<https://github.com/pyinstaller/pyinstaller>
|
|
||||||
- Everything frozen above the bootloader (markitdown + Python packages +
|
|
||||||
CPython runtime) is permissively licensed (MIT/Apache/BSD/PSF/MPL);
|
|
||||||
see THIRD-PARTY-NOTICES.md §2 for the list.
|
|
||||||
- CPython runtime source: <https://www.python.org/downloads/source/>
|
|
||||||
(PSF License — not GPL, listed here for completeness).
|
|
||||||
|
|
||||||
## libvips (via sharp prebuilt binaries) — LGPL-2.1-or-later
|
|
||||||
|
|
||||||
- Shipped as dynamically-loaded libraries from `@img/*` prebuilts for sharp 0.35.4
|
|
||||||
- Source: <https://github.com/libvips/libvips> · prebuilt bundle sources:
|
|
||||||
<https://github.com/lovell/sharp-builds>
|
|
||||||
- LGPL compliance: the app's own source is public (MIT) and the libraries
|
|
||||||
remain separately replaceable files in the installation directory
|
|
||||||
(`node_modules/@img/`), satisfying the relinking requirement.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
_Versions and hashes above correspond to the release this file ships with;
|
|
||||||
update them when bumping bundled tool versions._
|
|
||||||
@@ -1,108 +0,0 @@
|
|||||||
# Third-Party Notices & Licenses
|
|
||||||
|
|
||||||
MarkdownConverter (this app) is MIT-licensed. This document lists the
|
|
||||||
third-party components that are **distributed with** the application, their
|
|
||||||
licenses, and where to obtain source code. Full license texts for the
|
|
||||||
copyleft and font licenses referenced here are in the `third-party-licenses/`
|
|
||||||
folder shipped alongside this file (and in the source repository).
|
|
||||||
|
|
||||||
This product includes software developed by third parties under the licenses
|
|
||||||
below. Copyright and license notices are reproduced verbatim or referenced
|
|
||||||
per each license's terms.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 1. This application
|
|
||||||
|
|
||||||
**MarkdownConverter** — Copyright (C) 2024-2025 ConcreteInfo (Amit Haridas) —
|
|
||||||
MIT License. See the repository `LICENSE` file.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 2. Bundled external binaries
|
|
||||||
|
|
||||||
These run as separate operating-system processes, launched via `execFile`
|
|
||||||
with literal argv (never a shell, never linked into the app).
|
|
||||||
|
|
||||||
| Component | Version | License | Notes |
|
|
||||||
|---|---|---|---|
|
|
||||||
| Pandoc | 3.9.0.2 | GPL-2.0-or-later | Downloaded at build time by `scripts/download-tools.js` (SHA-256 pinned); license: [GPL-2.0](third-party-licenses/GPL-2.0.txt) |
|
|
||||||
| FFmpeg | bundled by `ffmpeg-static` 5.3.0 | **GPL-3.0-or-later build** (`--enable-gpl --enable-libx264/x265`) | License text: <https://ffmpeg.org/legal.html>; source offer below |
|
|
||||||
| MarkItDown | 0.1.7 (+ Python deps) | MIT | Microsoft's any-file→Markdown importer, frozen with PyInstaller by `scripts/bundle-markitdown.js`; includes an embedded CPython runtime (PSF license) |
|
|
||||||
| sharp / libvips prebuilt binaries | 0.35.4 | Apache-2.0 / **LGPL-2.1-or-later** (libvips) | Dynamically loaded native addon; LGPL compliance: this app's full MIT source is public, enabling relinking; license: [LGPL-2.1](third-party-licenses/LGPL-2.1.txt) |
|
|
||||||
| KaTeX (CSS + fonts) | 0.18.5 | MIT | `assets/katex/` |
|
|
||||||
| JetBrains Mono, Fira Code fonts | — | SIL OFL 1.1 | `assets/fonts/`; license: [OFL-1.1](third-party-licenses/OFL-1.1.txt) |
|
|
||||||
| Electron | 41.x | MIT | and its bundled Chromium (BSD-style licenses) / Node.js (MIT) / OpenSSL (Apache-2.0) — see <https://www.electronjs.org/blog/electron-licensing> |
|
|
||||||
|
|
||||||
### GPL source availability (GPL §3 offer)
|
|
||||||
|
|
||||||
Corresponding source for every GPL-licensed binary distributed with this app
|
|
||||||
is available on written request and from these permanent locations — see
|
|
||||||
**[SOURCES.md](SOURCES.md)** for exact versions and URLs.
|
|
||||||
|
|
||||||
### Python packages inside the bundled MarkItDown binary
|
|
||||||
|
|
||||||
The frozen MarkItDown binary embeds CPython and (each MIT/Apache-2.0/BSD-3/
|
|
||||||
PSF/MPL-2.0 licensed unless noted): markitdown, onnxruntime (MIT), numpy
|
|
||||||
(BSD-3), magika (Apache-2.0), beautifulsoup4 / soupsieve (MIT), requests
|
|
||||||
(Apache-2.0) + urllib3/idna/charset-normalizer, certifi (MPL-2.0),
|
|
||||||
markdownify, defusedxml (PSF), protobuf (BSD-3), flatbuffers (Apache-2.0),
|
|
||||||
pdfminer.six (MIT), python-docx, python-pptx, openpyxl, extract-msg,
|
|
||||||
markdown-it-py / mdurl, pyinstaller (GPL-2.0-with-exception — build tool
|
|
||||||
only; its bootloader is embedded, source offer included in SOURCES.md),
|
|
||||||
Packaging, six, click, chardet (LGPL — dynamically loadable Python module).
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## 3. npm dependencies shipped in the app (runtime)
|
|
||||||
|
|
||||||
| Package | Version | License |
|
|
||||||
|---|---|---|
|
|
||||||
| @cantoo/pdf-lib | 2.9.1 | MIT |
|
|
||||||
| @codemirror/* (autocomplete, commands, lang-*, language, lint, search, state, theme-one-dark, view), codemirror | 6.x | MIT |
|
|
||||||
| @replit/codemirror-vim | 6.4.0 | MIT |
|
|
||||||
| core-util-is | 1.0.3 | MIT |
|
|
||||||
| docx | 9.6.1 | MIT |
|
|
||||||
| dompurify | 3.4.14 | (MPL-2.0 OR Apache-2.0) |
|
|
||||||
| electron-store | 10.1.0 | MIT |
|
|
||||||
| ffmpeg-static | 5.3.0 | GPL-3.0-or-later (binary; see §2) |
|
|
||||||
| highlight.js | 11.11.1 | BSD-3-Clause |
|
|
||||||
| html2pdf.js | 0.14.0 | MIT |
|
|
||||||
| jszip | 3.10.1 | (MIT OR GPL-3.0-or-later) |
|
|
||||||
| katex | 0.18.5 | MIT |
|
|
||||||
| marked, marked-footnote, marked-highlight | 17.x / 1.4 / 2.2 | MIT |
|
|
||||||
| mermaid | 11.17.2 | MIT |
|
|
||||||
| pdfjs-dist | 5.5.207 | Apache-2.0 |
|
|
||||||
| pdfkit | 0.17.2 | MIT |
|
|
||||||
| pizzip | 3.2.0 | (MIT OR GPL-3.0) |
|
|
||||||
| sharp | 0.35.4 | Apache-2.0 (+ LGPL libvips binaries; see §2) |
|
|
||||||
| simple-git | 3.36.0 | MIT |
|
|
||||||
| tslib | 2.8.1 | 0BSD |
|
|
||||||
|
|
||||||
(Development-only dependencies — electron-builder, eslint, prettier, jest,
|
|
||||||
cross-env, @testing-library/dom — are not distributed with the application.)
|
|
||||||
|
|
||||||
## 4. Optional external tools (NOT bundled)
|
|
||||||
|
|
||||||
These are detected and used when the user installs them; no copy is
|
|
||||||
distributed with this app, so no redistribution obligations arise:
|
|
||||||
|
|
||||||
- **LibreOffice** (MPL-2.0) — enhanced Office-format conversion
|
|
||||||
- **MiKTeX / TeX Live** (LPPL/GPL per component) — LaTeX PDF export
|
|
||||||
- **ImageMagick** (Apache-2.0-style) — extra image formats in the universal converter
|
|
||||||
- **PlantUML** (GPL-3.0) + a Java runtime — local diagram rendering
|
|
||||||
- **Calibre** (`ebook-convert`) — MOBI export
|
|
||||||
- **System MarkItDown with `[all]` extras** — audio transcription / OCR
|
|
||||||
|
|
||||||
## 5. Trademarks
|
|
||||||
|
|
||||||
Product names used to describe compatibility (Pandoc, FFmpeg, LibreOffice,
|
|
||||||
MarkItDown, Microsoft, Excel, Word, PowerPoint…) are trademarks of their
|
|
||||||
respective owners and are not affiliated with this project.
|
|
||||||
|
|
||||||
## 6. License texts
|
|
||||||
|
|
||||||
See the `third-party-licenses/` directory: `GPL-2.0.txt`, `LGPL-2.1.txt`,
|
|
||||||
`MPL-2.0.txt`, `Apache-2.0.txt`, `OFL-1.1.txt`, `PSF-Python.txt`. MIT and
|
|
||||||
BSD-3-Clause texts are short and reproduced in each package's own repository;
|
|
||||||
per-package LICENSE files also ship inside `node_modules/` in source form.
|
|
||||||
-339
@@ -1,339 +0,0 @@
|
|||||||
# PanConverter - Updates & Changelog
|
|
||||||
|
|
||||||
## Version 4.7.0 (2026-09-05)
|
|
||||||
|
|
||||||
### Bundling & Legal Compliance
|
|
||||||
- **MarkItDown is now bundled**: `npm run bundle:markitdown` freezes Microsoft's
|
|
||||||
markitdown (MIT) + embedded Python runtime into a single ~75MB per-platform
|
|
||||||
binary (`bin/<platform>/markitdown`) via PyInstaller (ML extras excluded);
|
|
||||||
the app prefers the bundled binary and falls back to system installs
|
|
||||||
- Packaging copies the bundled markitdown for Windows/macOS/Linux alongside Pandoc
|
|
||||||
- **THIRD-PARTY-NOTICES.md** — full license inventory of everything distributed
|
|
||||||
(bundled binaries, npm runtime deps, fonts, embedded Python packages)
|
|
||||||
- **SOURCES.md** — GPL §3(b) written source offer for Pandoc / FFmpeg (GPL build) /
|
|
||||||
PyInstaller bootloader, with pinned versions + SHA-256; LGPL relinking note for libvips
|
|
||||||
- **third-party-licenses/** — canonical texts: GPL-2.0, LGPL-2.1, MPL-2.0,
|
|
||||||
Apache-2.0, OFL-1.1, PSF-Python
|
|
||||||
- **Help → Third-Party Notices & Licenses** — in-app viewer for both documents
|
|
||||||
- **download-tools.js** now SHA-256 pins and verifies every downloaded artifact
|
|
||||||
(post-download and against the cache on every run; hard-fails on mismatch)
|
|
||||||
- README gains a "Bundled Dependencies, Legal Notices & Credits" section
|
|
||||||
- Large optional tools intentionally NOT bundled (documented): LibreOffice,
|
|
||||||
MiKTeX/TeX Live, ImageMagick, PlantUML+JRE, Calibre
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Version 4.6.1 (2026-09-05)
|
|
||||||
|
|
||||||
### New Features
|
|
||||||
- **MarkItDown import** — "File → Import with MarkItDown (Any Format)…" embeds
|
|
||||||
Microsoft's [markitdown](https://github.com/microsoft/markitdown) (MIT) as an
|
|
||||||
any-file → Markdown path: PDF, DOCX, PPTX, XLSX, Outlook .msg/.eml, EPUB,
|
|
||||||
images, CSV/JSON/XML, ZIP; audio transcription and OCR with the `[all]` extras
|
|
||||||
- Command auto-resolution: `markitdown` binary, then `python -m markitdown` /
|
|
||||||
`python3 -m markitdown` (probed once, cached)
|
|
||||||
- Same SEC-1 argv discipline as Pandoc (execFile only, paths never through a shell),
|
|
||||||
50MB input cap, 120s timeout, path-sanitized errors that surface markitdown's
|
|
||||||
actionable `pip install 'markitdown[...]'` hints
|
|
||||||
- Output written next to the source as `<name>.md` (numeric suffix instead of
|
|
||||||
overwriting) and opened in a new tab; `markitdown:available` / `markitdown:convert`
|
|
||||||
IPC for future renderer flows
|
|
||||||
- **AI Assistant: Anthropic-compatible provider** — any base URL speaking the
|
|
||||||
Anthropic messages schema (LiteLLM proxies, Bedrock gateways, local servers);
|
|
||||||
x-api-key + Bearer auth, keyless proxies supported, tolerates bases with or
|
|
||||||
without a trailing `/v1`
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
- File → Open PDF crashed the PDF editor (null operation matched no section; now
|
|
||||||
defaults to Merge)
|
|
||||||
- Backlinks panel required the wrong module path (failed at registration)
|
|
||||||
- writing-studio engines/panels now await their IPC-backed settings/file backends
|
|
||||||
(eliminates `JSON.parse("[object Promise]")` crashes)
|
|
||||||
- Manuscript panel's window.prompt (unsupported in Electron) replaced with an
|
|
||||||
inline dialog; collaboration comment store made async to match its IO
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Version 4.6.0 (2026-09-05)
|
|
||||||
|
|
||||||
### New Features
|
|
||||||
|
|
||||||
#### AI Assistant Plugin (multi-provider)
|
|
||||||
- Chat sidebar panel with rolling conversation history and insert-reply-into-document
|
|
||||||
- Providers: OpenAI, Anthropic, Ollama, LM Studio, and any OpenAI-compatible endpoint
|
|
||||||
- All provider traffic proxied through the main process — API keys never enter the renderer and the CSP stays closed to AI endpoints
|
|
||||||
- Commands: AI Summarize / Improve / Explain / Translate selection
|
|
||||||
- Answers the writing-studio `ai:analyze` contract, finally enabling the Proofread panel
|
|
||||||
|
|
||||||
#### Collaboration Plugin (inline comments)
|
|
||||||
- Anchor-based comments stored in `.comments/` sidecar files (never exported, never committed)
|
|
||||||
- Comments sidebar panel: add at cursor, list, resolve, delete, jump to anchor
|
|
||||||
- Drift detection flags moved/edited anchors; F8 navigates to the next open comment
|
|
||||||
|
|
||||||
#### Local Knowledge Base (wiki-links + backlinks)
|
|
||||||
- `[[Note]]`, `[[Note|alias]]`, `[[Note#section]]` render as links in the preview (code blocks excluded)
|
|
||||||
- Clicking a wiki-link opens the note or offers to create it
|
|
||||||
- Backlinks sidebar panel scans the folder (bounded BFS) for documents linking to the current one
|
|
||||||
|
|
||||||
#### Crash Recovery / Session Restore
|
|
||||||
- Open tabs (paths + unsaved buffer content) snapshotted to localStorage, debounced on edits, on tab changes, on unload, and once a minute
|
|
||||||
- Restore prompt on launch with per-tab restore, clean-fresh option, and 2MB content budget
|
|
||||||
|
|
||||||
#### Document Version History
|
|
||||||
- Every save snapshots the previous on-disk content to `<userData>/versions/`
|
|
||||||
- History sidebar panel: list, restore (with safety snapshot), unified diff vs. current, delete, manual "save version now"
|
|
||||||
- Per-document pruning (20 versions), path-hash storage, id-validated reads
|
|
||||||
|
|
||||||
#### Editor
|
|
||||||
- Vim keybindings (View → Vim Mode, persisted, live toggle via CodeMirror Compartment)
|
|
||||||
- Snippet Tab-expansion: type a snippet name and press Tab to insert it
|
|
||||||
- Zen Mode word-goal setter (the HUD progress bar finally has UI)
|
|
||||||
|
|
||||||
#### Export / Conversion
|
|
||||||
- **Real PDF encryption**: pdf-lib swapped for @cantoo/pdf-lib — encrypt/decrypt/permissions now actually work (UI auto-enables via the capability probe)
|
|
||||||
- **XLSX export**: markdown tables → native Excel workbook, one sheet per table (no Pandoc needed)
|
|
||||||
- **ODT headers/footers + page size**: real ODF styles.xml patching replaces the empty stub
|
|
||||||
- **Local PlantUML rendering**: diagrams render on-machine via the `plantuml` CLI when installed; plantuml.com stays as fallback
|
|
||||||
- **KaTeX bundled locally** (CSS + fonts): math renders offline, no CDN calls
|
|
||||||
- Writing heatmap (GitHub-style 30-day grid) in the writing-studio Goals panel
|
|
||||||
|
|
||||||
#### Platform
|
|
||||||
- Quick Note global scratchpad (Ctrl+Alt+Q, works when unfocused; appends to `notes/quick-notes.md`)
|
|
||||||
- Deep link protocol `markdownconverter://open?path=…`
|
|
||||||
- REPL confirmation dialog before first code execution per language per session (unsandboxed-execution guard rail)
|
|
||||||
- Writing-studio's four sidebar panels (Manuscript/Goals/Snapshots/Proofread) are now actually wired with rail icons
|
|
||||||
- Plugin sidebar panels get automatic rail icons via `registerPanel({icon})`
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
- `Ctrl+Shift+P` collision: PDF (Enhanced) export now `Ctrl+Alt+Shift+P`; Command Palette keeps `Ctrl+Shift+P`
|
|
||||||
- Universal Converter's Pandoc tool no longer always reports "not installed" (`checkConverterAvailable` gained a pandoc case with bundled-binary check)
|
|
||||||
- CLI headless export: removed dangling `--css` / `--reference-doc` flags that made pandoc exit with an error; `--self-contained` replaced with `--standalone` (Pandoc 3.x)
|
|
||||||
- Removed dead "Open Export Options Dialog…" button from the converter dialog
|
|
||||||
- Removed duplicate `styles-zen.css` include
|
|
||||||
|
|
||||||
### Security
|
|
||||||
- AI provider requests carry size caps (200KB prompt), timeouts (120s), and user-safe error surfaces
|
|
||||||
- Version-history reads validate ids against traversal; history listing requires a valid document path
|
|
||||||
- PlantUML local rendering removes the diagram-text exfiltration path when a local CLI exists (CVE-MC-007 follow-up)
|
|
||||||
|
|
||||||
### Tests
|
|
||||||
- New suites: OdtStyling, AiProviders, ai-assistant prompts, collaboration comment-store, wiki-links/backlinks, session-store, XlsxExporter, VersionHistory
|
|
||||||
- PDFOperations encryption tests rewritten for the real-encryption reality
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Version 4.0.0 (2026-03-04)
|
|
||||||
|
|
||||||
### Major Changes
|
|
||||||
- **CodeMirror 6 Editor** — Replaced textarea with CodeMirror 6 featuring syntax highlighting, code folding, bracket matching, multiple cursors, and auto-indent
|
|
||||||
- **Sidebar Panel System** — Collapsible sidebar with File Explorer, Git, Snippets, and Templates panels
|
|
||||||
- **Command Palette** — Ctrl+Shift+P to search and execute all app actions
|
|
||||||
- **Code Execution (REPL)** — Run JavaScript, Python, and Bash code blocks directly from the preview
|
|
||||||
|
|
||||||
### New Features
|
|
||||||
- Print Preview dialog with paper size, orientation, margins, scale, and page range controls
|
|
||||||
- Image paste from clipboard and drag-drop support with auto-save to assets folder
|
|
||||||
- Document templates library (10 templates: blog post, meeting notes, tech spec, changelog, README, project plan, API docs, tutorial, release notes, comparison)
|
|
||||||
- Markdown extensions: footnotes, admonitions (note/warning/tip/danger/info), and [[toc]] table of contents
|
|
||||||
- PlantUML diagram rendering alongside Mermaid
|
|
||||||
- Welcome tab with onboarding and "What's New" feature showcase
|
|
||||||
- System spell checking with context menu suggestions and dictionary support
|
|
||||||
- Enhanced status bar with word count, character count, line/column, encoding, and language mode
|
|
||||||
- Grouped toolbar with visual section separators
|
|
||||||
- Breadcrumb bar showing current file path
|
|
||||||
|
|
||||||
### New Export/Import Formats
|
|
||||||
- Reveal.js slides (.html)
|
|
||||||
- Beamer slides (.pdf)
|
|
||||||
- Confluence/Jira wiki markup (.txt)
|
|
||||||
- MOBI e-books (via Calibre)
|
|
||||||
- Developer formats: JSON, YAML, XML, TOML
|
|
||||||
|
|
||||||
### Security
|
|
||||||
- Content Security Policy (CSP) meta tag
|
|
||||||
- File size validation (50MB limit)
|
|
||||||
- Error message sanitization (stripped file paths)
|
|
||||||
- Conversion rate limiting (2-second debounce)
|
|
||||||
|
|
||||||
### Dependencies Updated
|
|
||||||
- marked: 16.x to 17.x (with marked-highlight extension)
|
|
||||||
- pdfjs-dist: 3.x to 5.x (new worker model)
|
|
||||||
- html2pdf.js: 0.10 to 0.14
|
|
||||||
- pdfkit: 0.14 to 0.17
|
|
||||||
- dompurify, docx, and others updated to latest
|
|
||||||
|
|
||||||
### Testing
|
|
||||||
- 80 tests across 7 test suites
|
|
||||||
- New tests for sidebar manager, command palette, print preview, markdown extensions, and utility functions
|
|
||||||
|
|
||||||
### Breaking Changes
|
|
||||||
- Editor is now CodeMirror 6 (replaces textarea)
|
|
||||||
- marked API changed to use marked.use() instead of marked.setOptions()
|
|
||||||
- pdfjs-dist upgraded to v5 with new worker model
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Version 2.1.0 (December 14, 2025)
|
|
||||||
|
|
||||||
### 🎨 UI/UX Improvements
|
|
||||||
|
|
||||||
#### Subtle & Small Preview Popout Button
|
|
||||||
- Redesigned popout button with minimalist aesthetic
|
|
||||||
- Removed border for cleaner appearance
|
|
||||||
- Reduced size: 11px font, 2px×6px padding (previously 14px font, 4px×8px padding)
|
|
||||||
- Added opacity transition: 50% when idle, 100% on hover
|
|
||||||
- Subtle background effect on hover instead of heavy border styling
|
|
||||||
- **File**: `src/styles.css:195-211`
|
|
||||||
|
|
||||||
#### Simplified Table Headers in Preview
|
|
||||||
- Removed gradient background from table headers in modern theme
|
|
||||||
- Changed from `var(--primary-gradient)` (purple gradient) to simple light gray (#f0f0f0)
|
|
||||||
- Updated text color to dark (#333333) for better readability
|
|
||||||
- Clean, professional appearance matching standard themes
|
|
||||||
- **File**: `src/styles-modern.css:445-449`
|
|
||||||
|
|
||||||
### 📥 Enhanced Import Capabilities
|
|
||||||
|
|
||||||
#### Comprehensive Format-to-Markdown Conversion
|
|
||||||
Dramatically expanded the "Import Document" feature to support 30+ file formats:
|
|
||||||
|
|
||||||
**Supported Formats:**
|
|
||||||
- **Documents**: DOCX, ODT, RTF, HTML, HTM, TEX, EPUB, PDF, TXT
|
|
||||||
- **Presentations**: PPTX, ODP
|
|
||||||
- **Markup Languages**: RST, Textile, MediaWiki, Org-mode, AsciiDoc, TWiki, OPML
|
|
||||||
- **E-book Formats**: EPUB, FB2
|
|
||||||
- **LaTeX Formats**: TEX, LATEX, LTX
|
|
||||||
- **Web Formats**: HTML, HTM, XHTML
|
|
||||||
- **Wiki Formats**: MediaWiki, DokuWiki, TikiWiki, TWiki
|
|
||||||
- **Data Formats**: CSV, TSV, JSON
|
|
||||||
|
|
||||||
**Format-Specific Optimizations:**
|
|
||||||
- PDF text extraction with XeLaTeX engine
|
|
||||||
- CSV/TSV automatic table conversion
|
|
||||||
- JSON structure handling
|
|
||||||
- Improved error messages with format hints
|
|
||||||
|
|
||||||
**Access**: File → Import Document (Ctrl+I)
|
|
||||||
**File**: `src/main.js:1933-1994`
|
|
||||||
|
|
||||||
### 🎨 Exhaustive ASCII Art Generator
|
|
||||||
|
|
||||||
#### 5 New Text Banner Styles
|
|
||||||
Complete alphabet (A-Z) and numbers (0-9) support for all styles:
|
|
||||||
|
|
||||||
1. **Standard** - Classic ASCII art with slashes and underscores
|
|
||||||
2. **Banner** - Large format using # characters (7-line height)
|
|
||||||
3. **Block** - Modern Unicode block characters (█ ╔ ╗ ═ ║)
|
|
||||||
4. **Bubble** - Circular bubble letters (Ⓐ Ⓑ Ⓒ)
|
|
||||||
5. **Digital** - Digital display style (▄ ▀ ▐ ▌)
|
|
||||||
|
|
||||||
**File**: `src/renderer.js:3397-3537`
|
|
||||||
|
|
||||||
#### 19 Professional ASCII Templates
|
|
||||||
Organized into 4 categories with expanded options:
|
|
||||||
|
|
||||||
**Arrows & Flow (4 templates):**
|
|
||||||
- Arrow Right - Horizontal flow indicators
|
|
||||||
- Arrow Down - Vertical flow indicators
|
|
||||||
- Decision - Binary decision diagrams
|
|
||||||
- Process Flow - Multi-step process visualization
|
|
||||||
|
|
||||||
**Diagrams & Charts (6 templates):**
|
|
||||||
- Flowchart - Advanced flowchart with decision branches and loops
|
|
||||||
- Sequence - Sequence diagrams for User-System-Database interactions
|
|
||||||
- Network - Server-client network topology
|
|
||||||
- Hierarchy - Organizational tree structures
|
|
||||||
- Timeline - Milestone visualization with dates
|
|
||||||
- Table Simple - Basic table template with borders
|
|
||||||
|
|
||||||
**Boxes & Containers (4 templates):**
|
|
||||||
- Header - Section header with decorative borders
|
|
||||||
- Note Box - Important notes with rounded corners (┏━━┓)
|
|
||||||
- Warning Box - Warning messages with bold borders (╔═══╗)
|
|
||||||
- Info Box - Information boxes with subtle styling (╭───╮)
|
|
||||||
|
|
||||||
**Decorative Elements (6 templates):**
|
|
||||||
- Divider - Horizontal section separator (═══)
|
|
||||||
- Separator Fancy - Elegant rounded divider
|
|
||||||
- Brackets - Japanese-style brackets 【 】
|
|
||||||
- Banner Stars - Star-bordered banners
|
|
||||||
- Checklist - Task lists with ✓ checkmarks
|
|
||||||
- Progress Bar - Visual progress indicators
|
|
||||||
|
|
||||||
**Features:**
|
|
||||||
- All ASCII art automatically wrapped in code blocks for proper rendering
|
|
||||||
- Preserved formatting in markdown preview and all export formats
|
|
||||||
- Categorized template selection interface
|
|
||||||
- Real-time preview generation
|
|
||||||
|
|
||||||
**Access**: Tools → ASCII Art Generator
|
|
||||||
**Files**: `src/renderer.js:3513-3671`, `src/index.html:427-466`
|
|
||||||
|
|
||||||
### 📝 Technical Improvements
|
|
||||||
|
|
||||||
- Enhanced ASCII art detection in Word template exporter
|
|
||||||
- Improved monospace font rendering across all export formats
|
|
||||||
- Better code block preservation in PDF and Word exports
|
|
||||||
- Optimized template categorization and organization
|
|
||||||
|
|
||||||
### 🔧 Files Modified
|
|
||||||
|
|
||||||
- `src/styles.css` - Preview popout button styling
|
|
||||||
- `src/styles-modern.css` - Table header simplification
|
|
||||||
- `src/main.js` - Enhanced import function, version update
|
|
||||||
- `src/renderer.js` - ASCII art generator enhancements
|
|
||||||
- `src/index.html` - ASCII template UI organization
|
|
||||||
- `package.json` - Version bump to 2.1.0
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Version 2.0.0 (Previous Release)
|
|
||||||
|
|
||||||
### Major Features
|
|
||||||
- Export Profiles - Save and reuse export configurations
|
|
||||||
- Mermaid.js diagram support
|
|
||||||
- Command Palette (Ctrl+Shift+P)
|
|
||||||
- GitHub Light/Dark preview themes
|
|
||||||
- Table Generator
|
|
||||||
- ASCII Art Generator (basic)
|
|
||||||
- Resizable Preview Pane
|
|
||||||
- Pop-out Preview Window
|
|
||||||
- Configurable page sizes (A3-A5, B4-B5, Letter, Legal, Tabloid, Custom)
|
|
||||||
- Custom Headers & Footers for exports
|
|
||||||
- Enhanced PDF and Word export with templates
|
|
||||||
- 22 beautiful themes
|
|
||||||
|
|
||||||
### Core Capabilities
|
|
||||||
- Cross-platform markdown editor with live preview
|
|
||||||
- Universal document conversion (30+ formats)
|
|
||||||
- PDF Editor (merge, split, compress, rotate, watermark, encrypt)
|
|
||||||
- Batch file conversion
|
|
||||||
- File association support
|
|
||||||
- Advanced export options
|
|
||||||
- Multi-tab interface
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Installation & Usage
|
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
- **Pandoc** - Required for document conversion
|
|
||||||
- **Optional**: LibreOffice, ImageMagick, FFmpeg for universal converter
|
|
||||||
|
|
||||||
### Download
|
|
||||||
Get the latest release from: https://github.com/amitwh/pan-converter/releases
|
|
||||||
|
|
||||||
### Supported Platforms
|
|
||||||
- Windows (x64)
|
|
||||||
- Linux (AppImage, .deb, .snap)
|
|
||||||
- macOS (planned)
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Contributions are welcome! Please see [CLAUDE.md](CLAUDE.md) for development guidelines.
|
|
||||||
|
|
||||||
**Author**: Amit Haridas (amit.wh@gmail.com)
|
|
||||||
**License**: MIT
|
|
||||||
**Repository**: https://github.com/amitwh/pan-converter
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 869 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.5 KiB |
File diff suppressed because one or more lines are too long
@@ -1,93 +0,0 @@
|
|||||||
Copyright (c) 2014, The Fira Code Project Authors (https://github.com/tonsky/FiraCode)
|
|
||||||
|
|
||||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
|
||||||
This license is copied below, and is also available with a FAQ at:
|
|
||||||
http://scripts.sil.org/OFL
|
|
||||||
|
|
||||||
|
|
||||||
-----------------------------------------------------------
|
|
||||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
|
||||||
-----------------------------------------------------------
|
|
||||||
|
|
||||||
PREAMBLE
|
|
||||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
|
||||||
development of collaborative font projects, to support the font creation
|
|
||||||
efforts of academic and linguistic communities, and to provide a free and
|
|
||||||
open framework in which fonts may be shared and improved in partnership
|
|
||||||
with others.
|
|
||||||
|
|
||||||
The OFL allows the licensed fonts to be used, studied, modified and
|
|
||||||
redistributed freely as long as they are not sold by themselves. The
|
|
||||||
fonts, including any derivative works, can be bundled, embedded,
|
|
||||||
redistributed and/or sold with any software provided that any reserved
|
|
||||||
names are not used by derivative works. The fonts and derivatives,
|
|
||||||
however, cannot be released under any other type of license. The
|
|
||||||
requirement for fonts to remain under this license does not apply
|
|
||||||
to any document created using the fonts or their derivatives.
|
|
||||||
|
|
||||||
DEFINITIONS
|
|
||||||
"Font Software" refers to the set of files released by the Copyright
|
|
||||||
Holder(s) under this license and clearly marked as such. This may
|
|
||||||
include source files, build scripts and documentation.
|
|
||||||
|
|
||||||
"Reserved Font Name" refers to any names specified as such after the
|
|
||||||
copyright statement(s).
|
|
||||||
|
|
||||||
"Original Version" refers to the collection of Font Software components as
|
|
||||||
distributed by the Copyright Holder(s).
|
|
||||||
|
|
||||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
|
||||||
or substituting -- in part or in whole -- any of the components of the
|
|
||||||
Original Version, by changing formats or by porting the Font Software to a
|
|
||||||
new environment.
|
|
||||||
|
|
||||||
"Author" refers to any designer, engineer, programmer, technical
|
|
||||||
writer or other person who contributed to the Font Software.
|
|
||||||
|
|
||||||
PERMISSION & CONDITIONS
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
|
||||||
redistribute, and sell modified and unmodified copies of the Font
|
|
||||||
Software, subject to the following conditions:
|
|
||||||
|
|
||||||
1) Neither the Font Software nor any of its individual components,
|
|
||||||
in Original or Modified Versions, may be sold by itself.
|
|
||||||
|
|
||||||
2) Original or Modified Versions of the Font Software may be bundled,
|
|
||||||
redistributed and/or sold with any software, provided that each copy
|
|
||||||
contains the above copyright notice and this license. These can be
|
|
||||||
included either as stand-alone text files, human-readable headers or
|
|
||||||
in the appropriate machine-readable metadata fields within text or
|
|
||||||
binary files as long as those fields can be easily viewed by the user.
|
|
||||||
|
|
||||||
3) No Modified Version of the Font Software may use the Reserved Font
|
|
||||||
Name(s) unless explicit written permission is granted by the corresponding
|
|
||||||
Copyright Holder. This restriction only applies to the primary font name as
|
|
||||||
presented to the users.
|
|
||||||
|
|
||||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
|
||||||
Software shall not be used to promote, endorse or advertise any
|
|
||||||
Modified Version, except to acknowledge the contribution(s) of the
|
|
||||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
|
||||||
permission.
|
|
||||||
|
|
||||||
5) The Font Software, modified or unmodified, in part or in whole,
|
|
||||||
must be distributed entirely under this license, and must not be
|
|
||||||
distributed under any other license. The requirement for fonts to
|
|
||||||
remain under this license does not apply to any document created
|
|
||||||
using the Font Software.
|
|
||||||
|
|
||||||
TERMINATION
|
|
||||||
This license becomes null and void if any of the above conditions are
|
|
||||||
not met.
|
|
||||||
|
|
||||||
DISCLAIMER
|
|
||||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
|
||||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
|
||||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
|
||||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
||||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
|
||||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
|
||||||
File diff suppressed because one or more lines are too long
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -1,93 +0,0 @@
|
|||||||
Copyright 2020 The JetBrains Mono Project Authors (https://github.com/JetBrains/JetBrainsMono)
|
|
||||||
|
|
||||||
This Font Software is licensed under the SIL Open Font License, Version 1.1.
|
|
||||||
This license is copied below, and is also available with a FAQ at:
|
|
||||||
https://scripts.sil.org/OFL
|
|
||||||
|
|
||||||
|
|
||||||
-----------------------------------------------------------
|
|
||||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
|
||||||
-----------------------------------------------------------
|
|
||||||
|
|
||||||
PREAMBLE
|
|
||||||
The goals of the Open Font License (OFL) are to stimulate worldwide
|
|
||||||
development of collaborative font projects, to support the font creation
|
|
||||||
efforts of academic and linguistic communities, and to provide a free and
|
|
||||||
open framework in which fonts may be shared and improved in partnership
|
|
||||||
with others.
|
|
||||||
|
|
||||||
The OFL allows the licensed fonts to be used, studied, modified and
|
|
||||||
redistributed freely as long as they are not sold by themselves. The
|
|
||||||
fonts, including any derivative works, can be bundled, embedded,
|
|
||||||
redistributed and/or sold with any software provided that any reserved
|
|
||||||
names are not used by derivative works. The fonts and derivatives,
|
|
||||||
however, cannot be released under any other type of license. The
|
|
||||||
requirement for fonts to remain under this license does not apply
|
|
||||||
to any document created using the fonts or their derivatives.
|
|
||||||
|
|
||||||
DEFINITIONS
|
|
||||||
"Font Software" refers to the set of files released by the Copyright
|
|
||||||
Holder(s) under this license and clearly marked as such. This may
|
|
||||||
include source files, build scripts and documentation.
|
|
||||||
|
|
||||||
"Reserved Font Name" refers to any names specified as such after the
|
|
||||||
copyright statement(s).
|
|
||||||
|
|
||||||
"Original Version" refers to the collection of Font Software components as
|
|
||||||
distributed by the Copyright Holder(s).
|
|
||||||
|
|
||||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
|
||||||
or substituting -- in part or in whole -- any of the components of the
|
|
||||||
Original Version, by changing formats or by porting the Font Software to a
|
|
||||||
new environment.
|
|
||||||
|
|
||||||
"Author" refers to any designer, engineer, programmer, technical
|
|
||||||
writer or other person who contributed to the Font Software.
|
|
||||||
|
|
||||||
PERMISSION & CONDITIONS
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of the Font Software, to use, study, copy, merge, embed, modify,
|
|
||||||
redistribute, and sell modified and unmodified copies of the Font
|
|
||||||
Software, subject to the following conditions:
|
|
||||||
|
|
||||||
1) Neither the Font Software nor any of its individual components,
|
|
||||||
in Original or Modified Versions, may be sold by itself.
|
|
||||||
|
|
||||||
2) Original or Modified Versions of the Font Software may be bundled,
|
|
||||||
redistributed and/or sold with any software, provided that each copy
|
|
||||||
contains the above copyright notice and this license. These can be
|
|
||||||
included either as stand-alone text files, human-readable headers or
|
|
||||||
in the appropriate machine-readable metadata fields within text or
|
|
||||||
binary files as long as those fields can be easily viewed by the user.
|
|
||||||
|
|
||||||
3) No Modified Version of the Font Software may use the Reserved Font
|
|
||||||
Name(s) unless explicit written permission is granted by the corresponding
|
|
||||||
Copyright Holder. This restriction only applies to the primary font name as
|
|
||||||
presented to the users.
|
|
||||||
|
|
||||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
|
||||||
Software shall not be used to promote, endorse or advertise any
|
|
||||||
Modified Version, except to acknowledge the contribution(s) of the
|
|
||||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
|
||||||
permission.
|
|
||||||
|
|
||||||
5) The Font Software, modified or unmodified, in part or in whole,
|
|
||||||
must be distributed entirely under this license, and must not be
|
|
||||||
distributed under any other license. The requirement for fonts to
|
|
||||||
remain under this license does not apply to any document created
|
|
||||||
using the Font Software.
|
|
||||||
|
|
||||||
TERMINATION
|
|
||||||
This license becomes null and void if any of the above conditions are
|
|
||||||
not met.
|
|
||||||
|
|
||||||
DISCLAIMER
|
|
||||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
|
||||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
|
||||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
|
||||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
||||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
|
|
||||||
OTHER DEALINGS IN THE FONT SOFTWARE.
|
|
||||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 206 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 885 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 885 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 606 B |
Binary file not shown.
|
Before Width: | Height: | Size: 1.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.0 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 206 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.9 KiB |
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user