Skip to content

Commit de6e9a5

Browse files
authored
Fix markdown syntax error in README (#264)
1 parent 4bdcfab commit de6e9a5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,8 @@ You can import an existing project that contains a `compile_commands.json` file,
115115
The language server (clangd) searches for a `compile_commands.json` file in the source file folder and its parents. Users can define a `.clangd` file in the project root to configure clangd (e.g. add include paths).
116116
A [.clangd](https://clangd.llvm.org/config#files) is a text file with YAML syntax. A `compile_commands.json` file can be generated by CMake.
117117

118-
[!TIP]
119-
This configuration entry in the `.clangd` file would tell clangd to use the `compile_commands.json` file in the build/default folder:
118+
> [!TIP]
119+
> This configuration entry in the `.clangd` file would tell clangd to use the `compile_commands.json` file in the build/default folder:
120120
121121
```yaml
122122
CompileFlags:
@@ -141,11 +141,11 @@ This file may be hidden by default, therefore to see the file uncheck the *.\* r
141141
By default C/C++ will be opened with the standard CEditor.
142142
The default can be changed per project or per workspace with the *C/C++ General* -> *Editor (LSP)* -> *Set C/C++ Editor (LSP) as default* checkbox in the project properties or workspace preference page.
143143

144-
[!TIP]
145-
The workspace setting will be used for projects that have not checked the *Enable project specific settings* checkbox in the project properties -> *C/C++ General* -> *Editor (LSP)* page.
144+
> [!TIP]
145+
> The workspace setting will be used for projects that have not checked the *Enable project specific settings* checkbox in the project properties -> *C/C++ General* -> *Editor (LSP)* page.
146146

147-
[!NOTE]
148-
Opening a C/C++ file using *Open With* in the context menu of a file won't work for the LSP based editor, because the language server won't be started if *Set C/C++ Editor (LSP) as default* is not enabled!
147+
> [!IMPORTANT]
148+
> Opening a C/C++ file using *Open With* in the context menu of a file won't work for the LSP based editor, because the language server won't be started if *Set C/C++ Editor (LSP) as default* is not enabled!
149149

150150
With the *C/C++ Editor (LSP)* open, the presentation of the C++ file will follow the LSP4E conventions augmented by the information returned from clangd.
151151

0 commit comments

Comments
 (0)