Documented editor shortcuts

 Closes BookStackApp/BookStack#452
 
 

diff --git a/content/docs/user/markdown-editor.md b/content/docs/user/markdown-editor.md
new file mode 100644 (file) index 0000000..941af06
--- /dev/null
+++ b/content/docs/user/markdown-editor.md
@@ -0,0 +1,77 @@
++++
+title = "Markdown Editor"
+description = "Details on using the markdown editor in BookStack"
+date = "2017-07-28"
+type = "user-docs"
++++
+
+If you prefer the write in Markdown the editor in BookStack can be changed at a 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.
+
+### Editor Shortcuts
+
+The following shortcuts are available in the Markdown Editor:
+
+<table>
+  <thead>
+    <tr>
+      <th>Shortcut (Windows &amp; Linux/Mac)</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>Ctrl+S</code> / <code>Cmd+S</code></td>
+      <td>Save Draft</td>
+    </tr>
+    <tr>
+      <td>
+        <code>Ctrl+1</code> / <code>Cmd+1</code> <br>
+        <code>Ctrl+2</code> / <code>Cmd+2</code> <br>
+        <code>Ctrl+3</code> / <code>Cmd+3</code> <br>
+        <code>Ctrl+4</code> / <code>Cmd+4</code>
+      </td>
+      <td>
+        Header Large (h2)<br>
+        Header Medium (h3)<br>
+        Header Small (h4)<br>
+        Header Tiny (h5)
+      </td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+5</code> / <code>Cmd+5</code><br><code>Ctrl+D</code> / <code>Cmd+D</code></td>
+      <td>Normal Paragraph</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+6</code> / <code>Cmd+6</code><br><code>Ctrl+Q</code> / <code>Cmd+Q</code></td>
+      <td>Blockquote</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+7</code> / <code>Cmd+7</code><br><code>Ctrl+E</code> / <code>Cmd+E</code></td>
+      <td>Code Block</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+8</code> / <code>Cmd+8</code><br><code>Ctrl+Shift+E</code> / <code>Cmd+Shift+E</code></td>
+      <td>Inline Code</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+9</code> / <code>Cmd+9</code></td>
+      <td>Callout (Info)</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+K</code> / <code>Cmd+K</code></td>
+      <td>Insert Link</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+Shift+K</code> / <code>Cmd+Shift+K</code></td>
+      <td>Show link selector</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+Shift+I</code> / <code>Cmd+Shift+I</code></td>
+      <td>Insert Image</td>
+    </tr>
+  </tbody>
+</table>

diff --git a/content/docs/user/reusing-content.md b/content/docs/user/reusing-content.md
index 06c82fa9ded1be7ca0c786f922bd1791a05acc19..f6aaa8ddd6cf15203961f1bffc97ecf34babfb22 100644 (file)
--- a/content/docs/user/reusing-content.md
+++ b/content/docs/user/reusing-content.md
@@ -31,7 +31,7 @@ By default this contains a direct link to that content. If you click the link ic
 
 <video controls src="/images/2017/01/bookstack-includes-popover.mp4"></video>
 
-## Forcing Content Id's
+## Forcing Content ID's
 
 When including a specific block of content the id of the block is used (part after the hash). By default these are generated by BookStack when you save a page. If you are using the WYSIWYG editor the id will stay the same unless the block is removed or re-formatted. In the markdown editor it changes every save and references the content so while it may remain the same there's a good chance an ID can change.
 

diff --git a/content/docs/user/searching.md b/content/docs/user/searching.md
index 61ef4133abf1bc1895c4a0059c55686180e2c6ed..4d8b5cad89f01b2420fbc03ae2b59277220d2a17 100644 (file)
--- a/content/docs/user/searching.md
+++ b/content/docs/user/searching.md
@@ -21,10 +21,10 @@ All of the above search locations within BookStack share the ability to use adva
 
 <table width="100%">
   <tr style="font-weight:bold;">
-    <td width="16%">Search Type</td>
-    <td width="20%">Syntax</td>
-    <td width="16%">Examples</td>
-    <td>Description</td>
+    <th width="16%">Search Type</th>
+    <th width="20%">Syntax</th>
+    <th width="16%">Examples</th>
+    <th>Description</th>
   </tr>
   <tr>
     <td>Normal Searches</td>
@@ -72,9 +72,9 @@ Filters are set advanced search features that can be used in your search term. T
 
 <table width="100%">
   <tr style="font-weight:bold;">
-    <td width="25%">Syntax</td>
-    <td width="25%">Examples</td>
-    <td>Description</td>
+    <th width="25%">Syntax</th>
+    <th width="25%">Examples</th>
+    <th>Description</th>
   </tr>
   <tr style="font-weight:bold;">
     <td colspan="3">Date Filters</td>

diff --git a/content/docs/user/wysiwyg-editor.md b/content/docs/user/wysiwyg-editor.md
new file mode 100644 (file) index 0000000..6f2e0aa
--- /dev/null
+++ b/content/docs/user/wysiwyg-editor.md
@@ -0,0 +1,74 @@
++++
+title = "Default Page Editor"
+description = "Details on the standard Page editor in BookStack"
+date = "2017-07-28"
+type = "user-docs"
++++
+
+The default editor in BookStack is a 'What You See Is What You Get' (WYSIWYG) editor.
+The usage of this editor is similar to typical word-processing applications such as Word or Google Docs.
+
+### Editor Shortcuts
+
+The following shortcuts are available in the WYSIWYG Editor:
+
+<table>
+  <thead>
+    <tr>
+      <th>Shortcut (Windows &amp; Linux/Mac)</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td><code>Ctrl+S</code> / <code>Cmd+S</code></td>
+      <td>Save Draft</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+B</code> / <code>Cmd+B</code></td>
+      <td>Bold</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+I</code> / <code>Cmd+I</code></td>
+      <td>Italic</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+U</code> / <code>Cmd+U</code></td>
+      <td>Underline</td>
+    </tr>
+    <tr>
+      <td>
+        <code>Ctrl+1</code> / <code>Cmd+1</code> <br>
+        <code>Ctrl+2</code> / <code>Cmd+2</code> <br>
+        <code>Ctrl+3</code> / <code>Cmd+3</code> <br>
+        <code>Ctrl+4</code> / <code>Cmd+4</code>
+      </td>
+      <td>
+        Header Large <br>
+        Header Medium <br>
+        Header Small <br>
+        Header Tiny
+      </td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+5</code> / <code>Cmd+5</code><br><code>Ctrl+D</code> / <code>Cmd+D</code></td>
+      <td>Normal Paragraph</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+6</code> / <code>Cmd+6</code><br><code>Ctrl+Q</code> / <code>Cmd+Q</code></td>
+      <td>Blockquote</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+7</code> / <code>Cmd+7</code><br><code>Ctrl+E</code> / <code>Cmd+E</code></td>
+      <td>Code Block</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+8</code> / <code>Cmd+8</code><br><code>Ctrl+Shift+E</code> / <code>Cmd+Shift+E</code></td>
+      <td>Inline Code</td>
+    </tr>
+    <tr>
+      <td><code>Ctrl+9</code> / <code>Cmd+9</code></td>
+      <td>Callout <br>(Keep pressing to toggle through styles)</td>
+    </tr>
+  </tbody>
+</table>

diff --git a/themes/bookstack/layouts/index.html b/themes/bookstack/layouts/index.html
index aa6bd944eb054e59de5c3d39e6e5f88f7cb3a8fc..9bab93b7f008849ef7ab9220d124168d613a9e73 100644 (file)
--- a/themes/bookstack/layouts/index.html
+++ b/themes/bookstack/layouts/index.html
@@ -42,7 +42,7 @@
             <div class="col-sm-4" >
                 <h4><span class="icon">{{partial "icon/search.svg"}}</span>Searchable and Connected</h4>
                 <p>
-                    The content in BookStack is fully searchable. You are able to search at book level or across all books, chapters &amp; pages. The ability to link directly to any paragraph allows you to keeps your documentation connected.
+                    The content in BookStack is fully searchable. You are able to search at book level or across all books, chapters &amp; pages. The ability to link directly to any paragraph allows you to keep your documentation connected.
                 </p>
             </div>
         </div>
@@ -252,4 +252,4 @@
 
        <script async src="libs/photoswipe.min.js"></script>
 
-{{ partial "footer.html" . }}
\ No newline at end of file
+{{ partial "footer.html" . }}

diff --git a/themes/bookstack/layouts/partials/menu_user_docs.html b/themes/bookstack/layouts/partials/menu_user_docs.html
index 43c0195057e0d71c739af0e7f8cc320144ac68db..01e7a78adaec9b3b6667cdc37149c4a291175574 100644 (file)
--- a/themes/bookstack/layouts/partials/menu_user_docs.html
+++ b/themes/bookstack/layouts/partials/menu_user_docs.html
@@ -7,6 +7,8 @@
 <h4>Common Functions</h4>
 <ul>
        <li><a href="/docs/user/searching">Searching Content</a></li>
+       <li><a href="/docs/user/wysiwyg-editor">Default (WYSIWYG) Editor</a></li>
+       <li><a href="/docs/user/markdown-editor">Markdown Editor</a></li>
 </ul>
 <h4>Advanced Features</h4>
 <ul>

diff --git a/themes/bookstack/sass/_html.scss b/themes/bookstack/sass/_html.scss
index 0eb945e1cdab52e2f0b5d19231514785e427efec..e067450e82e1104a1f3a16de3ca3b121e2767e84 100644 (file)
--- a/themes/bookstack/sass/_html.scss
+++ b/themes/bookstack/sass/_html.scss
@@ -15,9 +15,13 @@ body {
 
 table {
   min-width: 100px;
-  td {
+  td, th {
        min-width: 10px;
        padding: 4px 6px;
        border: 1px solid #DDD;
   }
-}
\ No newline at end of file
+  th {
+    background-color: #EEE;
+    font-weight: normal;
+  }
+}

diff --git a/themes/bookstack/sass/_text.scss b/themes/bookstack/sass/_text.scss
index 448056a8d880d9f9ea8a35b34c72cf8f01a1c382..ad818d2b3c0644775a898804fdd65a503d7f2046 100644 (file)
--- a/themes/bookstack/sass/_text.scss
+++ b/themes/bookstack/sass/_text.scss
@@ -193,6 +193,7 @@ code {
   white-space:pre;
   line-height: 1.2em;
   margin-bottom: 1.2em;
+  color: #c54545;
 }
 
 span.code {