feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Describe the markdown editor

Browse Source 
Task-number: QTCREATORBUG-28996
Change-Id: I9222f51e5e6c1131198a0eef0361531190675db9
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-04-27 16:54:10 +02:00
parent d172e59d6e
commit 85d25390c9
6 changed files with 29 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/qtcreator/images/qtcreator-markdown-editor.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

4
doc/qtcreator/src/editors/creator-coding.qdoc
View File

@@ -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

2
doc/qtcreator/src/editors/creator-only/creator-fakevim.qdoc
View File

@@ -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

2
doc/qtcreator/src/editors/creator-only/creator-language-server.qdoc
View File

@@ -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

22
doc/qtcreator/src/editors/creator-only/creator-markdown-editor.qdoc Normal file
View File

@@ -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}.
*/

1
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -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}