Skip to content

Commit aa6df4b

Browse files
committed
Update documentation styling and navigation structure
Restructured mkdocs.yml navigation to elevate LSP plugin to top-level menu section and improved YAML formatting consistency. Updated lsp.md with modern markdown syntax: replaced admonition blocks with blockquote notation, converted keyboard shortcuts to HTML kbd tags, standardized section spacing and list formatting, corrected typos (phphantom_lsp → phpantom_lsp, avilable → available), and replaced em-dash representations with proper em-dash characters in tables. Enhanced downloads.md by converting previous releases section from plain text link to structured table format for improved readability. Fixed trailing whitespace and removed unnecessary blank lines throughout. * docs/mkdocs.yml: navigation and formatting * docs/docs/plugins/lsp.md: markdown modernization and corrections * docs/docs/downloads/download.md: releases table restructuring **Generated by CodeLite** Signed-off-by: Eran Ifrah <eran@codelite.org>
1 parent 1b78ec0 commit aa6df4b

File tree

3 files changed

+142
-138
lines changed

3 files changed

+142
-138
lines changed

docs/docs/downloads/download.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ Signed-By: /etc/apt/keyrings/CodeLite.asc" |
6666
sudo tee /etc/apt/sources.list.d/CodeLite.sources > /dev/null
6767
```
6868

69+
6970
#### Adding the repository source
7071

7172
Add the appropriate line from the table below:
@@ -157,7 +158,15 @@ yaourt -S codelite
157158

158159
### Previous CodeLite releases
159160
---
160-
Links to older Linux packages are provided on [this page](./oldDownloads/Repositories18.1.md).
161+
162+
| Version | Link |
163+
|---------|------|
164+
| CodeLite 17.0 | [Repositories](/downloads/oldDownloads/Repositories17) |
165+
| CodeLite 16.0 | [Repositories](/downloads/oldDownloads/Repositories16) |
166+
| CodeLite 15.0 | [Repositories](/downloads/oldDownloads/Repositories15) |
167+
| CodeLite 14.0 | [Repositories](/downloads/oldDownloads/Repositories14) |
168+
| CodeLite 13.0 | [Repositories](/downloads/oldDownloads/Repositories13) |
169+
| CodeLite 12.0 | [Repositories](/downloads/oldDownloads/Repositories12) |
161170

162171
### wxCrafter binary packages
163172
---

docs/docs/plugins/lsp.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ sudo apt-get install clang-tools
4141

4242
After installation, proceed to the [manual configuration section](#manual-configuration).
4343

44-
!!! Note
45-
The `clang-tools` package often includes a version number (e.g., `clang-tools-10`). Install the package with the highest available version number.
44+
> **Note:** The `clang-tools` package often includes a version number (e.g., `clang-tools-10`). Install the package with the highest available version number.
4645
4746
**macOS**
4847

@@ -52,37 +51,39 @@ On macOS, `clangd` is provided as part of the `llvm` formula. Install it using H
5251
brew install llvm
5352
```
5453

55-
On ARM-based macOS systems, `clangd` is located at: `/opt/homebrew/opt/llvm/bin/clangd`
54+
On ARM-based macOS systems, `clangd` is located at `/opt/homebrew/opt/llvm/bin/clangd`.
5655

5756
### ctagsd (C/C++)
5857

5958
`ctagsd` is CodeLite's built-in code completion engine for C/C++ that implements the Language Server Protocol. It is automatically installed with CodeLite on all platforms.
6059

61-
CodeLite pre-configures `ctagsd`, but it is disabled by default. To enable it:
62-
63-
Navigate to **Plugins → Language Server → Settings**
60+
CodeLite pre-configures `ctagsd`, but it is disabled by default. To enable it, navigate to **Plugins → Language Server → Settings**.
6461

6562
### Pyright (Python)
6663

6764
**Prerequisites**
68-
- Node.js (any maintained LTS version) must be installed on your system.
69-
- `npm` (bundled with Node.js) must be available in your `PATH`.
65+
66+
- Node.js (any maintained LTS version) must be installed on your system
67+
- `npm` (bundled with Node.js) must be available in your `PATH`
7068

7169
**Installation**
70+
7271
Install Pyright globally via npm:
7372

7473
```bash
7574
npm install -g pyright
7675
```
7776

7877
**Verification**
78+
7979
Confirm the installation:
8080

8181
```bash
8282
pyright --version
8383
```
8484

8585
**Additional Resources**
86+
8687
- [Pyright Documentation](https://github.com/microsoft/pyright)
8788
- [Pyright on npm](https://www.npmjs.com/package/pyright)
8889

@@ -105,23 +106,22 @@ pip install python-lsp-server
105106

106107
Visit the [python-lsp-server project page][3] for additional information.
107108

108-
### phphantom_lsp (PHP)
109+
### phpantom_lsp (PHP)
109110

110-
`phphantom_lsp` is currently avilable via building it from sources.
111+
`phpantom_lsp` is currently available via building from sources.
111112

112113
**Standard Installation**
113114

114115
- [Install Rust][13]
115116

116-
**Build phphantom_lsp**
117+
**Build phpantom_lsp**
117118

118119
```bash
119120
git clone https://github.com/AJenbo/phpantom_lsp.git
120121
cargo build --release
121122
cargo install --path .
122123
```
123124

124-
125125
### TypeScript
126126

127127
**Prerequisites**
@@ -210,12 +210,12 @@ You can install and configure any language server that implements the LSP protoc
210210
|-------|-----------|-------------|
211211
| Enabled || Enable or disable this LSP |
212212
| Name || Provide a descriptive name for this LSP |
213-
| Remote server | - | When enabled, the command is executed on a remote machine |
213+
| Remote server | | When enabled, the command is executed on a remote machine |
214214
| Command || The LSP execution command (e.g., `/usr/bin/clangd` for clangd) |
215-
| Working directory | - | Path to set before running the command |
215+
| Working directory | | Path to set before running the command |
216216
| Languages || Associate this LSP with specific languages. Use the `...` button to view supported languages |
217217
| Connection string || Protocol used for communication (most LSP servers support `stdio`) |
218-
| Display diagnostics | - | When checked, CodeLite displays error indicators in the editor |
218+
| Display diagnostics | | When checked, CodeLite displays error indicators in the editor |
219219

220220
### Resolving Conflicts
221221

@@ -225,11 +225,11 @@ Multiple language servers can be configured for the same programming language (e
225225

226226
## Restarting Language Servers
227227

228-
To restart the any language server:
228+
To restart any language server:
229229

230-
1. Press ++ctrl+shift+p++ to open the command palette
230+
1. Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> to open the command palette
231231
2. Type `restart language` and select the appropriate command
232-
3. Hit ++enter++
232+
3. Press <kbd>Enter</kbd>
233233

234234
---
235235

docs/mkdocs.yml

Lines changed: 114 additions & 119 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,114 @@
1-
site_name: CodeLite Documentation
2-
site_url: https://www.codelite.org
3-
repo_url: https://github.com/eranif/codelite
4-
repo_name: GitHub
5-
edit_uri: edit/master/docs/docs
6-
nav:
7-
- Downloads:
8-
- Latest: downloads/download.md
9-
- Building from Source:
10-
- wxWidgets: build/build_wx_widgets.md
11-
- CodeLite: build/build_from_sources.md
12-
- MinGW: build/mingw_builds.md
13-
- Getting started:
14-
- Prepare your environment:
15-
- Windows: getting_started/windows.md
16-
- Linux: getting_started/linux.md
17-
- macOS: getting_started/macos.md
18-
- Hello World: hello_world.md
19-
- AI: AI/ai.md
20-
- LUA:
21-
- Overview: LUA/overview.md
22-
- Documentation: LUA/lua.md
23-
- Workspace:
24-
- C/C++: workspaces/default.md
25-
- File System Workspace: workspaces/file_system.md
26-
- Remote File System Workspace: /plugins/remoty
27-
- PHP (via plugin): workspaces/php.md
28-
- Node.js (via plugin): workspaces/nodejs.md
29-
- Plugins:
30-
- Language Server Protocol: plugins/lsp.md
31-
- Debug Adapter Client: plugins/dap.md
32-
- CMake: plugins/cmake.md
33-
- SFTP: plugins/sftp.md
34-
- SnipWiz: plugins/snipwiz.md
35-
- QMake: plugins/qmake.md
36-
- CppCheck: plugins/cppcheck.md
37-
- Subversion: plugins/svn.md
38-
- wxCrafter: plugins/wxcrafter.md
39-
- Git: plugins/git.md
40-
- UnitTest++: plugins/ut.md
41-
- Remoty: plugins/remoty.md
42-
- Rust: plugins/rust.md
43-
- Source Code Formatter: plugins/codeformatter.md
44-
- Debugging:
45-
- gdb: debuggers/gdb.md
46-
- Debug Adapter Client (dap): plugins/dap.md
47-
- XDebug (PHP): debuggers/xdebug.md
48-
- Node.js: debuggers/nodejs.md
49-
- Quick Debug: debuggers/quick_debug.md
50-
- wxWidgets:
51-
- wxWidgets 3.1.5: wxWidgets/repo315.md
52-
- wxWidgets 3.1.6: wxWidgets/repo316.md
53-
- wxWidgets 3.1.7: wxWidgets/repo317.md
54-
- wxWidgets 3.2.0: wxWidgets/repo320.md
55-
- wxWidgets 3.2.1: wxWidgets/repo321.md
56-
- wxWidgets 3.2: wxWidgets/repo32.md
57-
- Misc:
58-
- Look and feel: settings/colours_and_fonts.md
59-
- Keyboard shortcuts: settings/keyboard_shortcuts.md
60-
- Build Settings: settings/build_settings.md
61-
- Environment Variables: settings/environment_variables.md
62-
- Macros: /settings/macros
63-
- Local Preferences: misc/local_preferences.md
64-
- Sync Project with File System: misc/reconcile_project.md
65-
- Bookmarks: misc/bookmarks.md
66-
- Undo & Redo: misc/ur.md
67-
- Tab Groups: misc/tabgroups.md
68-
- Tips & Tricks: misc/tips_and_tricks.md
69-
- Install Rust: misc/install_rust.md
70-
- cc-wrapper: misc/cc_wrapper.md
71-
- Release Notes:
72-
- CodeLite v18.2.0: release_notes/v18_2_0.md
73-
- CodeLite v17.x - 18.0.0: release_notes/v18_0_0.md
74-
- CodeLite v16.x - 17.0.0: release_notes/v17_0_0.md
75-
- CodeLite v15.x - 16.0.0: release_notes/v16_0_0.md
76-
- Old Linux Repositories:
77-
- CodeLite 17.0: downloads/oldDownloads/Repositories17.md
78-
- CodeLite 16.0: downloads/oldDownloads/Repositories16.md
79-
- CodeLite 15.0: downloads/oldDownloads/Repositories15.md
80-
- CodeLite 14.0: downloads/oldDownloads/Repositories14.md
81-
- CodeLite 13.0: downloads/oldDownloads/Repositories13.md
82-
- CodeLite 12.0: downloads/oldDownloads/Repositories12.md
83-
theme:
84-
name: material
85-
features:
86-
- navigation.tabs
87-
- navigation.sections
88-
- navigation.top
89-
- content.code.copy
90-
91-
palette:
92-
# Palette toggle for light mode
93-
- scheme: default
94-
primary: white
95-
toggle:
96-
icon: material/toggle-switch-off-outline
97-
name: Switch to dark mode
98-
# Palette toggle for dark mode
99-
- scheme: slate
100-
primary: black
101-
toggle:
102-
icon: material/toggle-switch
103-
name: Switch to light mode
104-
highlightjs: true
105-
font:
106-
text: Roboto
107-
code: Roboto Mono
108-
109-
markdown_extensions:
110-
- pymdownx.keys
111-
- admonition
112-
- pymdownx.highlight
113-
- pymdownx.superfences
114-
- pymdownx.tabbed:
115-
alternate_style: true
116-
- pymdownx.tasklist:
117-
custom_checkbox: true
118-
extra:
119-
generator: false
1+
site_name: CodeLite Documentation
2+
site_url: https://www.codelite.org
3+
repo_url: https://github.com/eranif/codelite
4+
repo_name: GitHub
5+
edit_uri: edit/master/docs/docs
6+
nav:
7+
- Downloads:
8+
- Latest: downloads/download.md
9+
- Building from Source:
10+
- wxWidgets: build/build_wx_widgets.md
11+
- CodeLite: build/build_from_sources.md
12+
- MinGW: build/mingw_builds.md
13+
- Getting started:
14+
- Prepare your environment:
15+
- Windows: getting_started/windows.md
16+
- Linux: getting_started/linux.md
17+
- macOS: getting_started/macos.md
18+
- Hello World: hello_world.md
19+
- AI:
20+
- AI/ai.md
21+
- LSP:
22+
- plugins/lsp.md
23+
- LUA:
24+
- Overview: LUA/overview.md
25+
- Documentation: LUA/lua.md
26+
- Workspace:
27+
- C/C++: workspaces/default.md
28+
- File System Workspace: workspaces/file_system.md
29+
- Remote File System Workspace: /plugins/remoty
30+
- PHP (via plugin): workspaces/php.md
31+
- Node.js (via plugin): workspaces/nodejs.md
32+
- Plugins:
33+
- Language Server Protocol: plugins/lsp.md
34+
- Debug Adapter Client: plugins/dap.md
35+
- CMake: plugins/cmake.md
36+
- SFTP: plugins/sftp.md
37+
- SnipWiz: plugins/snipwiz.md
38+
- QMake: plugins/qmake.md
39+
- CppCheck: plugins/cppcheck.md
40+
- Subversion: plugins/svn.md
41+
- wxCrafter: plugins/wxcrafter.md
42+
- Git: plugins/git.md
43+
- UnitTest++: plugins/ut.md
44+
- Remoty: plugins/remoty.md
45+
- Rust: plugins/rust.md
46+
- Source Code Formatter: plugins/codeformatter.md
47+
- Debugging:
48+
- gdb: debuggers/gdb.md
49+
- Debug Adapter Client (dap): plugins/dap.md
50+
- XDebug (PHP): debuggers/xdebug.md
51+
- Node.js: debuggers/nodejs.md
52+
- Quick Debug: debuggers/quick_debug.md
53+
- wxWidgets:
54+
- wxWidgets 3.1.5: wxWidgets/repo315.md
55+
- wxWidgets 3.1.6: wxWidgets/repo316.md
56+
- wxWidgets 3.1.7: wxWidgets/repo317.md
57+
- wxWidgets 3.2.0: wxWidgets/repo320.md
58+
- wxWidgets 3.2.1: wxWidgets/repo321.md
59+
- wxWidgets 3.2: wxWidgets/repo32.md
60+
- Misc:
61+
- Look and feel: settings/colours_and_fonts.md
62+
- Keyboard shortcuts: settings/keyboard_shortcuts.md
63+
- Build Settings: settings/build_settings.md
64+
- Environment Variables: settings/environment_variables.md
65+
- Macros: /settings/macros
66+
- Local Preferences: misc/local_preferences.md
67+
- Sync Project with File System: misc/reconcile_project.md
68+
- Bookmarks: misc/bookmarks.md
69+
- Undo & Redo: misc/ur.md
70+
- Tab Groups: misc/tabgroups.md
71+
- Tips & Tricks: misc/tips_and_tricks.md
72+
- Install Rust: misc/install_rust.md
73+
- cc-wrapper: misc/cc_wrapper.md
74+
- Release Notes:
75+
- CodeLite v18.2.0: release_notes/v18_2_0.md
76+
- CodeLite v17.x - 18.0.0: release_notes/v18_0_0.md
77+
- CodeLite v16.x - 17.0.0: release_notes/v17_0_0.md
78+
- CodeLite v15.x - 16.0.0: release_notes/v16_0_0.md
79+
theme:
80+
name: material
81+
features:
82+
- navigation.tabs
83+
- navigation.sections
84+
- navigation.top
85+
- content.code.copy
86+
palette:
87+
# Palette toggle for light mode
88+
- scheme: default
89+
primary: white
90+
toggle:
91+
icon: material/toggle-switch-off-outline
92+
name: Switch to dark mode
93+
- scheme: slate
94+
# Palette toggle for dark mode
95+
96+
primary: black
97+
toggle:
98+
icon: material/toggle-switch
99+
name: Switch to light mode
100+
highlightjs: true
101+
font:
102+
text: Roboto
103+
code: Roboto Mono
104+
markdown_extensions:
105+
- pymdownx.keys
106+
- admonition
107+
- pymdownx.highlight
108+
- pymdownx.superfences
109+
- pymdownx.tabbed:
110+
alternate_style: true
111+
- pymdownx.tasklist:
112+
custom_checkbox: true
113+
extra:
114+
generator: false

0 commit comments

Comments
 (0)