-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make it clear that editor samples in the docs are demos #1188
Comments
The block toolbar is probably the most challenging example so far. As for the screenshots the most easy solution to distinguish demos and screenshots would be probably adding some styles to images that would make them stand out. Lika a border that makes them look like a post stamp or whatever. |
What about this:
I mean, it doesn't need to be an animated fairy flying around and pointing at the demo, but some encouragement might be nice? Also cc @wojtekidd and @gok9ok |
Ping. |
I'd see some sort of "window" around every editor. Something which pulls out the demo from the flow of the document. Perhaps, something similar to our blog: However, the tricky part here will be to give there enough white space around the demo so the "window" doesn't affect the "lightness" of the editor UI. In the future, we will also have to add stuff like tabs for HTML, JS and CSS and some "Edit" button. But that's... future. Recently, one more interesting idea appeared – to have a note next to each editor demo that it does not use all the features. With a link to a full list of those. People are apparently confused when checking our demos because we use a small subset of all available features. |
I think that to solve the problem you could use a clear (and esthetically-pleasing) CTA like a stamp that says "Play with the demo" or "This is a real CKEditor instance", etc. |
Example from notion.so: It's actually a working demo under this overlay. So you just click and it works. |
(somehow) related issue #6267. |
There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may be relevant, so if you're interested in the solution, leave a comment or reaction under this issue. |
We've closed your issue due to inactivity over the last year. We understand that the issue may still be relevant. If so, feel free to open a new one (and link this issue to it). |
Since the editors use the same font as the docs text, they are beautiful and consistent, but it's not always immediately clear that (1) they are interactive working examples and not a part of guide text and (2) they are not screenshots.
Any ideas how to make them stand out more, encourage people to play with them?
https://docs.ckeditor.com/ckeditor5/latest/features/blocktoolbar.html
https://docs.ckeditor.com/ckeditor5/latest/features/basic-styles.html
cc @m-kr @dkonopka @RyszardB
The text was updated successfully, but these errors were encountered: