Updated out-of-date markdown editor switching info

 Related to #124
 
 

diff --git a/content/docs/user/markdown-editor.md b/content/docs/user/markdown-editor.md
index 2aee73296034c2c7127e0771c902be301c2fb732..d4117a5099366d9ef9db4c507ba04e5714d53a79 100644 (file)
--- a/content/docs/user/markdown-editor.md
+++ b/content/docs/user/markdown-editor.md
@@ -5,21 +5,24 @@ date = "2017-07-28"
 type = "user-doc"
 +++
 
-If you prefer to write in Markdown, the editor in BookStack can be changed at an instance level
-to use a Markdown editor instead of the default WYSIWYG editor. The option to use Markdown is currently **not** a user setting but a global instance setting due to formatting differences between the two editors.
-
-> Note that shifting to the Markdown editor from the WYSIWYG editor may cause unintended side effects to existing content. This is due to the differences in the way the content is stored in the database.
+If you prefer to write in a simpler format, a Markdown editor is available in BookStack. Markdown compatibility generally follows that of [CommonMark](https://commonmark.org/), along with a few extensions including tables and task-lists.
 
 
 ### Switching to the Markdown Editor
 
-To change the editor to Markdown follow the steps below. You'll need to have the "Manage app settings" role permission to be able to follow these steps:
+The default editor option, for when creating a new page, can be configured by an admin within the "Settings > Customization" area of BookStack.
+
+You can change to the markdown editor at a page-level while within the page editor.
+Simply click the draft status, located above the page name input, and you'll be presented a dropdown with options which include those to change the editor. If you don't see these options, you may not have the relevent "Change page editor" system permission on one of your assigned system roles.
+
+![Editor Switch Menu Options](/images/docs/user/editor-switch-dropdown.png)
+
+For switching to Markdown, from the WYSIWYG editor, you'll see a couple of options:
 
-1. Within your BookStack instance, find and click on **Settings** in the navbar.
-2. Scroll down to the **Customization** section.
-3. Find the **Page Editor** setting and select `Markdown` from the dropdown menu.
-4. Save settings.
+- **Clean Content** - This is a system-cleaned markdown output, which is much nicer but has potential for formatting loss and potential functionality breaks (Things depending on HTML attributes/IDs for example).
+- **Stable Content** - This retains existing HTML content in Markdown to avoid any potential functionality breakages or loss of formatting.
 
+When you choose either option, there is risk of losing certain content details or formatting. BookStack will warn you of this when switching.
 
 ### Editor Shortcuts
 

diff --git a/static/images/docs/user/editor-switch-dropdown.png b/static/images/docs/user/editor-switch-dropdown.png
new file mode 100644 (file) index 0000000..b893d25
--- /dev/null
+++ b/static/images/docs/user/editor-switch-dropdown.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:af0693e0318647a68c023c1c1355f74cbda85d63400636a83bbc5b8077f45883
+size 15045