md2wiki 1.0.3 → 1.0.5

package/README.md

@@ -1,101 +1,52 @@
-<div align="center">
-  <br />
-  <img src="public/logo.svg" alt="md2wiki logo" width="160" />
-  <br />
-  <h1>🔄 MD2WIKI</h1>
-  <p><strong>Real-Time Markdown to MediaWiki Wikitext Converter</strong></p>
-  <p><i>A premium Next.js utility for Wikipedia editors featuring SUL OAuth 2.0 Sandbox publishing and CORS-free repository README importing.</i></p>
-
-  <br />
-
-  <div align="center">
-    <img src="https://img.shields.io/badge/Stack-Next.js%2015%20%7C%20Tailwind%20v4-emerald?style=for-the-badge" alt="Stack" />
-    <img src="https://img.shields.io/badge/License-MIT-blue?style=for-the-badge" alt="License" />
-    <img src="https://img.shields.io/badge/Platform-Wikimedia%20Toolforge-violet?style=for-the-badge" alt="Platform" />
-  </div>
-
-  <br />
-  <div align="center">
-    <img src="assets/preview.png" alt="Showcase Preview" width="600" style="border-radius: 12px; box-shadow: 0 8px 24px rgba(0, 0, 0, 0.25);" />
-  </div>
-  <br />
-</div>
+# md2wiki
 
----
-
-## 🧭 Navigation
+A real-time Markdown to MediaWiki Wikitext converter built with Next.js and Tailwind CSS. 
 
-* [📐 Project Vision](#-project-vision)
-* [✨ Key Features](#-key-features)
-* [🚀 Local Quick Start](#-local-quick-start)
-* [🔒 SUL OAuth 2.0 Credentials](#-sul-oauth-20-credentials)
-* [📦 Toolforge Deployment](#-toolforge-deployment)
-* [💻 Command Line Interface (CLI)](#-command-line-interface-cli)
+[![Discord](https://img.shields.io/badge/Discord-Lazy%20Devs-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/cNBReEyvK)
+[![License-MIT](https://img.shields.io/badge/License-MIT-blue?style=for-the-badge)](LICENSE)
 
 ---
 
-## 📐 Project Vision
+## About the Project
 
-Publishing Markdown drafts (offline notes, documentation, readmes) onto Wikipedia talk pages, user sandboxes, or Meta-Wiki requires translating the content into MediaWiki Wikitext markup. 
+**md2wiki** is a developer tool designed for Wikipedia editors and contributors. Writing long drafts or documentation offline in Markdown is standard, but publishing them on Wikipedia requires converting them into MediaWiki's native Wikitext markup. 
 
-**md2wiki** is a high-density, real-time translator that processes markdown formatting on the fly and integrates securely with your Wikipedia single user login (SUL) to write the output directly to your user sandbox page with one click.
+This application provides a real-time web interface that parses Markdown and compiles it into clean, compliant Wikitext instantly.
+
+![Showcase Preview](assets/preview.png)
 
 ---
 
-## ✨ Key Features
-
-<div align="center">
-  <table border="0" cellspacing="0" cellpadding="20">
-    <tr>
-      <td width="300" valign="top" style="border: 1px solid #333; border-radius: 15px; background: rgba(255,255,255,0.02); padding: 15px;">
-        <h3>⚡ Real-Time Compiler</h3>
-        <p>Instant, client-side translation of Markdown headers, text styling, tables, code blocks, lists, and links without network lag.</p>
-      </td>
-      <td width="300" valign="top" style="border: 1px solid #333; border-radius: 15px; background: rgba(255,255,255,0.02); padding: 15px;">
-        <h3>🛡️ Smart Heading Shift</h3>
-        <p>Detects Markdown H1s and auto-shifts headings to avoid duplicate H1 page titles on Wikipedia, conforming strictly to style guidelines.</p>
-      </td>
-    </tr>
-    <tr>
-      <td width="300" valign="top" style="border: 1px solid #333; border-radius: 15px; background: rgba(255,255,255,0.02); padding: 15px;">
-        <h3>🔗 Repository Importer</h3>
-        <p>Paste any GitHub or GitLab repository link, and our CORS-free proxy endpoint fetches, parses, and translates the README file.</p>
-      </td>
-      <td width="300" valign="top" style="border: 1px solid #333; border-radius: 15px; background: rgba(255,255,255,0.02); padding: 15px;">
-        <h3>📝 Sandbox SUL Publisher</h3>
-        <p>Log in securely via Wikimedia SUL OAuth 2.0 and save wikitext directly to <code>User:&lt;Username&gt;/sandbox</code> on any language Wikipedia.</p>
-      </td>
-    </tr>
-  </table>
-</div>
+## Key Features
 
----
+* **Real-time Translation:** Type or paste Markdown in the left editor and watch the formatted Wikitext compile on the right with zero lag.
+* **Smart Heading Shift:** Auto-shifts Markdown heading levels down by one (e.g., Markdown `#` becomes Wiki `== H2 ==`) to prevent duplicate H1 page titles on Wikipedia.
+* **Repository Importer:** Enter a GitHub or GitLab repository URL, and the tool will fetch and translate the README file automatically.
+* **Sandbox Publishing:** Log in securely via Wikimedia Single User Login (SUL) OAuth 2.0 to save your converted Wikitext directly to your Wikipedia user sandbox page.
+* **State Persistence:** Your progress is automatically cached in the browser's local storage, preventing data loss if you refresh the page or navigate away.
 
-## 🚀 Local Quick Start
+---
 
-Follow these steps to run the application on your local machine:
+## Local Development (Run on Localhost)
 
-### 1. Clone the repository
-```bash
-git clone https://github.com/your-username/md2wiki.git
-cd md2wiki
-```
+To run the application locally on your machine, follow these steps:
 
-### 2. Install dependencies
+### 1. Install Dependencies
 ```bash
 npm install
 ```
 
-### 3. Set up environment variables
-Create a `.env` file in the root directory (the application runs in **Mock SUL Mode** automatically if credentials are left blank):
+### 2. Configure Environment Variables (Optional)
+If you want to use SUL Sandbox publishing locally, copy `.env.example` or create a `.env` file:
 ```env
 WIKIMEDIA_CLIENT_ID=your_oauth_consumer_token
 WIKIMEDIA_CLIENT_SECRET=your_oauth_secret_token
-SESSION_SECRET=a_long_secure_session_encryption_key
+SESSION_SECRET=your_session_encryption_key
 WIKIMEDIA_REDIRECT_URI=http://localhost:8000/api/auth/callback
 ```
+*Note: If no `.env` is configured, the application automatically runs in **Mock SUL Mode** for safe local testing.*
 
-### 4. Start the development server
+### 3. Start the Server
 ```bash
 npm run dev
 ```
@@ -103,60 +54,16 @@ Open **[http://localhost:8000](http://localhost:8000)** in your browser.
 
 ---
 
-## 🔒 SUL OAuth 2.0 Credentials
-
-To enable sandbox publishing, register the tool:
-
-1. Log in to [Meta-Wiki](https://meta.wikimedia.org/).
-2. Navigate to [Special:OAuthConsumerRegistration/propose/oauth2](https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose/oauth2).
-3. Set the parameters:
-   * **OAuth callback URL**: `https://md2wiki.toolforge.org/api/auth/callback` (or `http://localhost:8000/api/auth/callback` for dev).
-   * **Grants**: Select **Basic rights** (`basic`), **Edit existing pages** (`edit`), and **Create, edit, and move pages** (`writepage` / `create`).
-4. Submit and record your **Consumer Token** and **Secret Token**.
-
----
-
-## 📦 Toolforge Deployment
-
-Wikimedia Toolforge supports hosting Node.js Next.js web applications using Kubernetes.
-
-### 1. SSH into Toolforge Bastion
-```bash
-ssh <username>@login.toolforge.org
-become <tool-name>
-```
-
-### 2. Clone and install dependencies
-Ensure files are cloned in your Toolforge home directory `www/js/`:
-```bash
-cd $HOME
-git clone https://github.com/your-username/md2wiki.git www/js
-cd www/js
-npm install
-```
-
-### 3. Create production `.env` file
-Include your Toolforge OAuth credentials, secret, and port details inside `www/js/.env`.
-
-### 4. Build and start
-```bash
-npm run build
-toolforge webservice node18 start
-```
-Traffic is automatically routed to `https://<tool-name>.toolforge.org/`.
-
----
-
-## 💻 Command Line Interface (CLI)
+## Command Line Interface (CLI)
 
-You can run the translator locally via command line to parse files:
+You can also run the translator directly via the command line to convert local files:
 
 ```bash
 npm run parse -- <path-to-markdown-file>
 ```
 
-For example, to convert `draft.md` and save the Wikitext output:
+**Example:**
 ```bash
-npm run parse -- draft.md > draft.wiki
+npm run parse -- draft.md > output.wiki
 ```
-Smart heading shifts and internal wiki link translation are enabled by default in CLI runs.
+*Smart heading shifts and Wikipedia link conversions are enabled by default on CLI runs.*

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "md2wiki",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Convert Markdown to MediaWiki Wikitext with SUL sandbox publishing.",
   "author": "lazyshrey",
   "repository": {