mirror of https://github.com/TryGhost/Ghost.git synced 2024-11-29 15:12:58 +03:00

History

Kevin Ansfield 756b6627a9 Editor refactors (#679 ) no issue * split key commands and text expansions into separate files for easier file searches * basic formatting, added a few comments * move editor title input into addon - the editor and title are now tightly integrated so that it's possible to use up/down cursor navigation so it makes more sense to keep them together - start of a deeper component restructure so that we don't need to leak properties/actions to parent components * first pass at refactor of gh-koenig and koenig-title-input - remove need for editor reference to be held outside of the `gh-koenig` component by yielding it from the component so that the integrated title element can sit inside the container's scope - refactor `gh-koenig` to more closely match the default ember mobiledoc addon - fixes runloop issues by starting/ending a manual runloop - refactored the mutation observer and event handlers in `koenig-title-input` so that we're not doing unecessary work on every render/key press - rename CSS classes to be more specific (these may still need more separation between `.gh` and `.kg` later) - `.editor-holder` to `.gh-koenig-container` - `.surface` to `.gh-koenig-surface` * fix tests and start testing refactor * move gh-koenig integration tests into addon, remove empty test files * first-pass at component template cleanup * first pass at koenig-toolbar-button refactor		2017-05-08 10:44:02 +01:00
..
addon	Editor refactors (#679 )	2017-05-08 10:44:02 +01:00
app	Editor refactors (#679 )	2017-05-08 10:44:02 +01:00
public/tools	remove unused codemirror files	2017-03-02 15:15:27 +00:00
test-support	Editor refactors (#679 )	2017-05-08 10:44:02 +01:00
.gitignore	Koenig tests. (#564 )	2017-03-07 23:57:09 +13:00
index.js	turn on linting for the editor, fix errors and match Ghost-Admin styles	2017-03-02 16:51:57 +00:00
package.json	fix addon preprocessor deprecation warning during build	2017-03-28 18:17:59 +01:00
README.md	renamed to koenig	2017-03-02 09:56:52 +00:00

README.md

gh-koenig

This is the new mobiledoc editor for Ghost-Admin. It's still a work in progress but we're very excited about it.

Here are a few of our goals:

To make the best ghosh darn writing experience on the interwebs.
To build a tool that works just as well for non technical content creators as power users.
To support rich content as easily as dealing with an image. Want a poll mid article? You got it. Want to paste a complete NG application in raw HTML? You got it.

When embarking on this project the last thing we wanted was to use one of those WYSIWYG editors with the million options and incomprehensible and inconsistent markup (you know who I'm talking about), to that end we chose to build our editor on top of mobiledoc-kit, you can read more about our decision here.

So why mobiledoc?

Mobiledoc is a new format for storing rich content, it's platform independent and isn't tied specifically to HTML (we can render a plain text version for a search index for instance). It allows for the embedding of rich applications inside your content using the cards paradigm. It's also a standard so content written in and for Ghost is compatible with any other mobiledoc system, and vice versa.

To us it seemed like the best compromise between a feature rich WYSIWYG editor and the markdown that we so love.

Like Ghost, Mobiledoc-kit is still moving towards its 1.0 release - it still has some bugs, but we're working together to make something really fun.

To try it out:

clone this repo
cd gh-koenig
npm install && bower install
ember serve
Visit http://localhost:4200
Click in the middle to activate the editor

If you want to help out:

Create an issue on the main Ghost repository https://github.com/TryGhost/Ghost/issues.
Clone the repo and create a branch.
Submit a PR.

A fantastic guide on the Ghost workflow is here: https://github.com/TryGhost/Ghost/wiki/Git-workflow, it's well worth a read.

Some features of the editor.

gh-koenig is very much a WYSIWYG editor but it supports a subset of markdown as content shortcuts for those of us who are mouse adverse, specifically:

# H1
## H2
### H3
1. Ordered Lists
* Unordered Lists
- Unordered Lists
> Block Quote
*italic*
_italic_
**bold**
__bold__
~~strikethrough~~
[link](http://www.ghost.org)
![image](https://ghost.org/assets/logos-f93942864f8c9f4a0a9b0ecd6f7f055c.png)
``` code blocks (generates a new markdown card) ```

There's also an inline menu that you can access by pressing the / key within the editor.

Right now we only have three built in "cards", a markdown card, an HTML card, and an Image card. But we plan to add the ability to install custom cards in the near future and have some big and exciting plans (and we're even more excited about what the community will do with it.), so watch this space.