Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ckeditor/github-writer

GitHub Writer - WYSIWYG Rich-Text Editor for GitHub, powered by CKEditor.
https://github.com/ckeditor/github-writer

Last synced: about 2 months ago
JSON representation

GitHub Writer - WYSIWYG Rich-Text Editor for GitHub, powered by CKEditor.

Host: GitHub
URL: https://github.com/ckeditor/github-writer
Owner: ckeditor
License: other
Created: 2019-11-06T09:06:38.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-04-09T09:58:43.000Z (8 months ago)
Last Synced: 2024-08-01T02:33:38.660Z (4 months ago)
Language: JavaScript
Homepage: https://ckeditor.com/
Size: 1.02 MB
Stars: 380
Watchers: 19
Forks: 61
Open Issues: 160
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome - ckeditor/github-writer - GitHub Writer - WYSIWYG Rich-Text Editor for GitHub, powered by CKEditor. (JavaScript)

README

## GitHub WYSIWYG Rich-Text Editor

GitHub Writer is a WYSIWYG rich-text editor for GitHub. The extension is available when creating or commenting on issues, reviews, pull requests, and wikis.

It provides all the features available in the GitHub plain-text editor, including Markdown input. For features like tables, it offers a much easier experience in comparison to plain-text Markdown and allows users to be more productive.

It is powered by [CKEditor 5](https://ckeditor.com/ckeditor-5/), a modern JavaScript rich-text editor.

### Installation

The extension can be found at the following directories for an easy one click installation:

* [GitHub Writer at Chrome Web Store](https://chrome.google.com/webstore/detail/github-writer/diilnnhpcdjhhkjcbdljaonhmhapadap)
* [GitHub Writer at Firefox Add-ons](https://addons.mozilla.org/en-US/firefox/addon/github-writer/)

### Features

One of the goals of this extension is to provide all the typical features available in the GitHub plain-text editor, including Markdown support. The following is the list of GitHub features, with the ones checked already available in GitHub Writer:

* Inline formatting
* Bold
* Italic
* Strikethrough
* Inline code
* Structure
* Paragraphs (Enter)
* Soft line-break (Shift+Enter)
* Headings
* Horizontal line separator
* Blocks
* Quotation
* Code block
* Language selection
* Lists
* Bulleted list
* Numbered list
* Task/To-do list
* Links
* On text
* Auto-link URLs on pasting.
* Auto-link URLs on typing.
* Media
* Image upload (including Wiki)
* Drag-and-drop
* Paste
* Open file dialog
* Mermaid diagrams
* Auto-complete
* People (list when typing "@")
* Issues and PRs (list when typing "#")
* Other
* Emoji
* OS, Unicode characters
* Auto-complete (list when typing ":")
* Escape Markdown in text
* Tables
* Quote selection (r key)
* PR code suggestions
* Saved replies

### Pages enabled

GitHub Writer should be enabled in all places where the original Markdown editor is available. The following are currently implemented:

* Issues
* New
* Editing
* Comment
* Editing
* Pull requests
* Create
* Comment
* Editing
* Review
* Code comments
* Editing
* Commits
* Comment
* Line comment
* Wiki pages
* Releases
* Milestones
* Settings > Saved Replies

### Developer information

The source code contains additional readme files with technical details about the project:

* [Development](dev/README.md) (setup, build, run).
* [Tests](tests/README.md) (architecture, configuration, run).
* [Architecture](src/README.md) (source code, API).

---

GitHub is a trademark of [GitHub](https://github.com/), Inc.