summaryrefslogtreecommitdiff
path: root/doc/qtcreator
diff options
context:
space:
mode:
Diffstat (limited to 'doc/qtcreator')
-rw-r--r--doc/qtcreator/images/qtcreator-markdown-editor.webpbin0 -> 22486 bytes
-rw-r--r--doc/qtcreator/src/editors/creator-coding.qdoc4
-rw-r--r--doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc2
-rw-r--r--doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc2
-rw-r--r--doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc22
-rw-r--r--doc/qtcreator/src/qtcreator-toc.qdoc1
6 files changed, 29 insertions, 2 deletions
diff --git a/doc/qtcreator/images/qtcreator-markdown-editor.webp b/doc/qtcreator/images/qtcreator-markdown-editor.webp
new file mode 100644
index 0000000000..0943d90fb3
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-markdown-editor.webp
Binary files differ
diff --git a/doc/qtcreator/src/editors/creator-coding.qdoc b/doc/qtcreator/src/editors/creator-coding.qdoc
index 9a45600f79..6823bf1c8f 100644
--- a/doc/qtcreator/src/editors/creator-coding.qdoc
+++ b/doc/qtcreator/src/editors/creator-coding.qdoc
@@ -68,6 +68,10 @@
\list
+ \li \l{Editing Markdown Files}
+
+ Edit and preview markdown (.md) files.
+
\li \l{Using Language Servers}
The language client offers code completion, highlighting of the
diff --git a/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc b/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
index e6f910b22a..dba4740fd6 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
@@ -4,7 +4,7 @@
/*!
\previouspage creator-editor-options-text.html
\page creator-editor-fakevim.html
- \nextpage creator-language-servers.html
+ \nextpage creator-markdown-editor.html
\title Using FakeVim Mode
diff --git a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc
index 248569aa78..348845a7bd 100644
--- a/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc
@@ -2,7 +2,7 @@
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
- \previouspage creator-editor-fakevim.html
+ \previouspage creator-markdown-editor.html
\page creator-language-servers.html
\nextpage creator-mime-types.html
diff --git a/doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc b/doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc
new file mode 100644
index 0000000000..9a3d2444e6
--- /dev/null
+++ b/doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc
@@ -0,0 +1,22 @@
+// Copyright (C) 2023 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \previouspage creator-editor-fakevim.html
+ \page creator-markdown-editor.html
+ \nextpage creator-language-servers.html
+
+ \title Editing Markdown Files
+
+ Open \l{https://www.markdownguide.org/basic-syntax/}{markdown} (.md) files
+ or select \uicontrol File > \uicontrol {New File} > \uicontrol {General} >
+ \uicontrol {Markdown File} to create a new file.
+
+ \image qtcreator-markdown-editor.webp {Markdown file in Preview and Editor views}
+
+ When you edit the file in the editor, you can see the changes in the preview.
+
+ To hide and show the views, select \uicontrol {Show Preview} and
+ \uicontrol {Show Editor}. To swap the places of the views, select
+ \uicontrol {Swap Views}.
+*/
diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc
index dc4256e262..e18f60632b 100644
--- a/doc/qtcreator/src/qtcreator-toc.qdoc
+++ b/doc/qtcreator/src/qtcreator-toc.qdoc
@@ -128,6 +128,7 @@
\li \l{Specifying Text Editor Settings}
\li \l{Using FakeVim Mode}
\endlist
+ \li \l{Editing Markdown Files}
\li \l{Using Language Servers}
\li \l{Editing MIME Types}
\li \l{Modeling}