chore: normalize dashes across project files
This commit is contained in:
TypoGenie
110
README.md
110
README.md
@@ -57,7 +57,7 @@
|
||||
|
||||
> **TypoGenie** is a free, open-source typesetting engine that democratizes beautiful document creation. No corporate subscriptions. No proprietary lock-in. No gatekeeping. Just you, your words, and 40+ professionally crafted styles ready to transform your Markdown into stunning Microsoft Word documents.
|
||||
|
||||
In a world where document formatting tools are increasingly locked behind paywalls and cloud dependencies, **TypoGenie stands as a testament to collective utility** — software built for the community, by the community, existing solely to serve the common good of anyone who needs to make their words look beautiful.
|
||||
In a world where document formatting tools are increasingly locked behind paywalls and cloud dependencies, **TypoGenie stands as a testament to collective utility** - software built for the community, by the community, existing solely to serve the common good of anyone who needs to make their words look beautiful.
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -65,7 +65,7 @@ In a world where document formatting tools are increasingly locked behind paywal
|
||||
|
||||
| 🌟 **Free Forever** | 🔒 **Privacy First** | 🎨 **150+ Styles** | 🤝 **Open Source** |
|
||||
|:---:|:---:|:---:|:---:|
|
||||
| No fees, no trials, no catches | All processing happens locally on your machine | From minimalist to ornate, academic to artistic | CC0 public domain — use it, fork it, improve it together |
|
||||
| No fees, no trials, no catches | All processing happens locally on your machine | From minimalist to ornate, academic to artistic | CC0 public domain - use it, fork it, improve it together |
|
||||
|
||||
</div>
|
||||
|
||||
@@ -77,12 +77,12 @@ In a world where document formatting tools are increasingly locked behind paywal
|
||||
|
||||
### 🎯 Core Capabilities
|
||||
|
||||
- **📄 Universal Markdown Support** — Drop in any `.md`, `.txt`, or `.markdown` file
|
||||
- **🎨 150+ Typography Styles** — Curated across 8 aesthetic categories
|
||||
- **📐 Multiple Paper Sizes** — A4 and Letter formats supported
|
||||
- **💾 Local Processing** — Your documents never leave your machine
|
||||
- **🖥️ Native Desktop App** — Built with Tauri for Windows (Portable EXE)
|
||||
- **📥 One-Click Export** — Clean `.docx` files ready for Microsoft Word
|
||||
- **📄 Universal Markdown Support** - Drop in any `.md`, `.txt`, or `.markdown` file
|
||||
- **🎨 150+ Typography Styles** - Curated across 8 aesthetic categories
|
||||
- **📐 Multiple Paper Sizes** - A4 and Letter formats supported
|
||||
- **💾 Local Processing** - Your documents never leave your machine
|
||||
- **🖥️ Native Desktop App** - Built with Tauri for Windows (Portable EXE)
|
||||
- **📥 One-Click Export** - Clean `.docx` files ready for Microsoft Word
|
||||
|
||||
### 🏛️ Style Categories
|
||||
|
||||
@@ -103,13 +103,13 @@ Each of the 163+ styles is a labor of love, crafted with attention to typographi
|
||||
|
||||
Every style includes meticulously configured:
|
||||
|
||||
- ✅ **Google Fonts Integration** — Beautiful web fonts that translate to Word
|
||||
- ✅ **Hierarchical Headings** — H1-H6 with distinct visual weight
|
||||
- ✅ **Body Text Optimization** — Optimal line height, spacing, and readability
|
||||
- ✅ **List Formatting** — Bulleted and numbered lists that work
|
||||
- ✅ **Blockquote Styling** — Pull quotes with accent colors
|
||||
- ✅ **Table Support** — Data tables with proper borders and alignment
|
||||
- ✅ **Bold & Italic** — Emphasis that carries through to the final document
|
||||
- ✅ **Google Fonts Integration** - Beautiful web fonts that translate to Word
|
||||
- ✅ **Hierarchical Headings** - H1-H6 with distinct visual weight
|
||||
- ✅ **Body Text Optimization** - Optimal line height, spacing, and readability
|
||||
- ✅ **List Formatting** - Bulleted and numbered lists that work
|
||||
- ✅ **Blockquote Styling** - Pull quotes with accent colors
|
||||
- ✅ **Table Support** - Data tables with proper borders and alignment
|
||||
- ✅ **Bold & Italic** - Emphasis that carries through to the final document
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -153,10 +153,10 @@ Every style includes meticulously configured:
|
||||
|
||||
### Option 1: Portable Download (Recommended) 🎒
|
||||
|
||||
**TypoGenie is fully portable** — no installation, no registry entries, no files scattered across your system.
|
||||
**TypoGenie is fully portable** - no installation, no registry entries, no files scattered across your system.
|
||||
|
||||
Just download and run:
|
||||
- 🪟 **Windows**: `TypoGenie.exe` — Single executable, runs immediately
|
||||
- 🪟 **Windows**: `TypoGenie.exe` - Single executable, runs immediately
|
||||
|
||||
**How it works:**
|
||||
```
|
||||
@@ -166,11 +166,11 @@ Just download and run:
|
||||
└── 📂 TypoGenie-Data/ ← Auto-created on first run (settings/cache)
|
||||
```
|
||||
|
||||
✅ **No installer** — Just double-click the EXE
|
||||
✅ **No registry** — Windows registry untouched
|
||||
✅ **No AppData** — Everything stays in the same folder
|
||||
✅ **USB-friendly** — Run from a thumb drive anywhere
|
||||
✅ **Easy backup** — Copy the whole folder, done
|
||||
✅ **No installer** - Just double-click the EXE
|
||||
✅ **No registry** - Windows registry untouched
|
||||
✅ **No AppData** - Everything stays in the same folder
|
||||
✅ **USB-friendly** - Run from a thumb drive anywhere
|
||||
✅ **Easy backup** - Copy the whole folder, done
|
||||
|
||||
### Option 2: Build from Source
|
||||
|
||||
@@ -196,7 +196,7 @@ npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
Your browser will open to `http://localhost:3000` — and you're ready to create!
|
||||
Your browser will open to `http://localhost:3000` - and you're ready to create!
|
||||
|
||||
#### Desktop App Development
|
||||
|
||||
@@ -212,7 +212,7 @@ npm run desktop:build
|
||||
|
||||
| Platform | Output Location | Result |
|
||||
|----------|----------------|--------|
|
||||
| **Windows** | `src-tauri/target/release/TypoGenie.exe` | ⚡ **Portable EXE** — Run immediately, no install |
|
||||
| **Windows** | `src-tauri/target/release/TypoGenie.exe` | ⚡ **Portable EXE** - Run immediately, no install |
|
||||
|
||||
**For the truly portable Windows experience:**
|
||||
1. Build the release (`npm run tauri build`).
|
||||
@@ -222,11 +222,11 @@ npm run desktop:build
|
||||
|
||||
### Usage
|
||||
|
||||
1. **📤 Upload** — Drag and drop your Markdown file (or click to browse)
|
||||
2. **🎨 Select Style** — Browse the gallery and click any style for live preview
|
||||
3. **📐 Choose Paper Size** — A4 or Letter, depending on your needs
|
||||
4. **✨ Generate** — Watch the magic happen (with a satisfying loading animation)
|
||||
5. **📥 Download** — Grab your `.docx` file, ready for Word
|
||||
1. **📤 Upload** - Drag and drop your Markdown file (or click to browse)
|
||||
2. **🎨 Select Style** - Browse the gallery and click any style for live preview
|
||||
3. **📐 Choose Paper Size** - A4 or Letter, depending on your needs
|
||||
4. **✨ Generate** - Watch the magic happen (with a satisfying loading animation)
|
||||
5. **📥 Download** - Grab your `.docx` file, ready for Word
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -295,8 +295,8 @@ Styles in TypoGenie are defined entirely in **JSON**, making them easy to edit a
|
||||
**The Dual Rendering Architecture:**
|
||||
|
||||
TypoGenie maintains two parallel rendering paths:
|
||||
1. **Web Preview** — Dynamically generates CSS from your JSON config on the fly.
|
||||
2. **DOCX Export** — Programmatically builds Word styles using the exact same JSON config.
|
||||
1. **Web Preview** - Dynamically generates CSS from your JSON config on the fly.
|
||||
2. **DOCX Export** - Programmatically builds Word styles using the exact same JSON config.
|
||||
|
||||
This ensures WYSIWYG fidelity: what you see in the preview is what you get in Word.
|
||||
|
||||
@@ -306,7 +306,7 @@ Want to contribute a new style?
|
||||
|
||||
1. **Create a JSON file** in a folder inside `templates/` (e.g., `templates/my-category/my-style.json`).
|
||||
2. **Define your style** using the schema above.
|
||||
3. **Restart the app** (or click refresh) — TypoGenie automatically discovers all `.json` files in the `templates/` directory.
|
||||
3. **Restart the app** (or click refresh) - TypoGenie automatically discovers all `.json` files in the `templates/` directory.
|
||||
|
||||
### Configuration Options
|
||||
|
||||
@@ -382,23 +382,23 @@ typogenie/
|
||||
|
||||
## 🤝 Contributing
|
||||
|
||||
TypoGenie is a **commons** — it belongs to everyone who uses it and improves it. We welcome contributions of all kinds:
|
||||
TypoGenie is a **commons** - it belongs to everyone who uses it and improves it. We welcome contributions of all kinds:
|
||||
|
||||
### Ways to Contribute
|
||||
|
||||
- 🎨 **New Styles** — Design and share new typography styles
|
||||
- 🐛 **Bug Reports** — Found something broken? Let us know!
|
||||
- 💡 **Feature Ideas** — Have a suggestion? Open a discussion
|
||||
- 📖 **Documentation** — Help us explain things better
|
||||
- 🔧 **Code Improvements** — Refactors, optimizations, fixes
|
||||
- 🌍 **Translations** — Help make TypoGenie accessible globally
|
||||
- 🎨 **New Styles** - Design and share new typography styles
|
||||
- 🐛 **Bug Reports** - Found something broken? Let us know!
|
||||
- 💡 **Feature Ideas** - Have a suggestion? Open a discussion
|
||||
- 📖 **Documentation** - Help us explain things better
|
||||
- 🔧 **Code Improvements** - Refactors, optimizations, fixes
|
||||
- 🌍 **Translations** - Help make TypoGenie accessible globally
|
||||
|
||||
### Contribution Guidelines
|
||||
|
||||
1. **Fork the repository**
|
||||
2. **Create a feature branch**: `git checkout -b feature/amazing-thing`
|
||||
3. **Make your changes** with clear, descriptive commits
|
||||
4. **Test thoroughly** — preview AND Word export
|
||||
4. **Test thoroughly** - preview AND Word export
|
||||
5. **Submit a Pull Request** with a detailed description
|
||||
|
||||
### Code of Conduct
|
||||
@@ -420,9 +420,9 @@ TypoGenie exists because we believe:
|
||||
|
||||
> **Access to beautiful tools for self-expression should not depend on one's ability to pay.**
|
||||
|
||||
In an era of increasingly proprietary, subscription-based software, TypoGenie is an offering to the digital commons — a tool that exists purely to serve those who need it, without extracting value, without surveillance, without artificial limitations.
|
||||
In an era of increasingly proprietary, subscription-based software, TypoGenie is an offering to the digital commons - a tool that exists purely to serve those who need it, without extracting value, without surveillance, without artificial limitations.
|
||||
|
||||
### CC0 1.0 Universal — Public Domain Dedication
|
||||
### CC0 1.0 Universal - Public Domain Dedication
|
||||
|
||||
[](https://creativecommons.org/publicdomain/zero/1.0/)
|
||||
|
||||
@@ -436,17 +436,17 @@ This project is released into the public domain under [CC0 1.0 Universal](LICENS
|
||||
|
||||
## 🙏 Acknowledgments
|
||||
|
||||
TypoGenie stands on the shoulders of giants — the countless open-source contributors who built the libraries, tools, and standards that make this project possible:
|
||||
TypoGenie stands on the shoulders of giants - the countless open-source contributors who built the libraries, tools, and standards that make this project possible:
|
||||
|
||||
- **The React Team** — For the component model that powers our UI
|
||||
- **The marked contributors** — For battle-tested Markdown parsing
|
||||
- **The docx maintainers** — For making client-side Word generation possible
|
||||
- **Google Fonts** — For democratizing access to beautiful typography
|
||||
- **Tailwind CSS** — For the utility-first approach that speeds development
|
||||
- **Vite** — For the build tooling that makes development a joy
|
||||
- **The broader open-source community** — For proving that collective, voluntary cooperation can create tools that rival (and exceed) proprietary alternatives
|
||||
- **The React Team** - For the component model that powers our UI
|
||||
- **The marked contributors** - For battle-tested Markdown parsing
|
||||
- **The docx maintainers** - For making client-side Word generation possible
|
||||
- **Google Fonts** - For democratizing access to beautiful typography
|
||||
- **Tailwind CSS** - For the utility-first approach that speeds development
|
||||
- **Vite** - For the build tooling that makes development a joy
|
||||
- **The broader open-source community** - For proving that collective, voluntary cooperation can create tools that rival (and exceed) proprietary alternatives
|
||||
|
||||
**And to you, the user** — for choosing tools that respect your freedom.
|
||||
**And to you, the user** - for choosing tools that respect your freedom.
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -468,10 +468,10 @@ TypoGenie stands on the shoulders of giants — the countless open-source contri
|
||||
|
||||
If TypoGenie brings value to your life, consider:
|
||||
|
||||
- ⭐ **Starring the repository** — Helps others discover it
|
||||
- 🗣️ **Spreading the word** — Tell friends and colleagues
|
||||
- 🔧 **Contributing code** — Improve it for everyone
|
||||
- 💝 **Supporting open-source** — Donate to the projects TypoGenie depends on
|
||||
- ⭐ **Starring the repository** - Helps others discover it
|
||||
- 🗣️ **Spreading the word** - Tell friends and colleagues
|
||||
- 🔧 **Contributing code** - Improve it for everyone
|
||||
- 💝 **Supporting open-source** - Donate to the projects TypoGenie depends on
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user