Skip to content

Commit

Permalink
Fix markdown syntax error in README (#264)
Browse files Browse the repository at this point in the history
  • Loading branch information
ghentschke authored Feb 20, 2024
1 parent 4bdcfab commit de6e9a5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,8 @@ You can import an existing project that contains a `compile_commands.json` file,
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).
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.

[!TIP]
This configuration entry in the `.clangd` file would tell clangd to use the `compile_commands.json` file in the build/default folder:
> [!TIP]
> This configuration entry in the `.clangd` file would tell clangd to use the `compile_commands.json` file in the build/default folder:
```yaml
CompileFlags:
Expand All @@ -141,11 +141,11 @@ This file may be hidden by default, therefore to see the file uncheck the *.\* r
By default C/C++ will be opened with the standard CEditor.
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.

[!TIP]
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.
> [!TIP]
> 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.

[!NOTE]
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!
> [!IMPORTANT]
> 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!

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.

Expand Down

0 comments on commit de6e9a5

Please sign in to comment.