https://github.com/bijx/steam-markup-generator

A lightweight rich-text editor that enables you to format text using Steam's custom markup tags, providing a live preview of the formatted content.
https://github.com/bijx/steam-markup-generator

markup steam workshop

Last synced: 2 months ago
JSON representation

A lightweight rich-text editor that enables you to format text using Steam's custom markup tags, providing a live preview of the formatted content.

• Host: GitHub
• URL: https://github.com/bijx/steam-markup-generator
• Owner: bijx
• License: mit
• Created: 2023-08-17T20:21:30.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-01-18T21:13:43.000Z (about 1 year ago)
• Last Synced: 2024-01-18T23:11:35.711Z (about 1 year ago)
• Topics: markup, steam, workshop
• Language: JavaScript
• Homepage: https://bijx.github.io/Steam-Markup-Generator/
• Size: 81.1 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Steam Markup Generator

A lightweight rich-text editor that enables you to format text using Steam's [custom markup tags](https://steamcommunity.com/comment/Recommendation/formattinghelp), providing a live preview of the formatted content.

## Features

- Basic text formatting options like **bold**, *italic*, underline, and strikethrough.

- Headers, horizontal rules, and code blocks support.

- Add quotations with authors and embed spoilers.

- Keyboard shortcuts for quick formatting.

  

## Usage

1. Type or paste the text you want to format into the editor.

2. Use the buttons above the editor or keyboard shortcuts to apply formatting.

3. See the live preview below the editor to check how your content looks.

## Keyboard Shortcuts

- **Bold**: Ctrl + B

- **Italic**: Ctrl + I

- **Underline**: Ctrl + U

- **Strike**: Ctrl + Shift + X

- **Header**: Ctrl + Shift + H

- **URL**: Ctrl + K

## Planned Features

- [x] Local storage saving to prevent progress loss

- [x] URL support

- [ ] Add remaining buttons

- [ ] More keybinds

- [ ] Markdown to Steam Markup converter

## Feedback

This is a beta version of the editor. If you encounter any issues or have suggestions for improvements, please [open an issue](https://github.com/bijx/Steam-Markup-Generator/issues).

## License

This project is licensed under the MIT License. See the `LICENSE` file for more details.