88* [ ✅ Features] ( #-features )
99* [ 🧪 Tested with] ( #-tested-with )
1010* [ 🚀 Getting Started] ( #-getting-started )
11- * [ 1. Configure environment and Python settings] ( #1-configure-environment-and-python-settings )
12- * [ 2. Set up Python project dependencies] ( #2-set-up-python-project-dependencies )
13- * [ 3. Build your Vim IDE image] ( #3-build-your-vim-ide-image )
14- * [ 4. Start developing inside the container] ( #4-start-developing-inside-the-container )
15- * [ 5. Update dependencies when needed] ( #5-update-dependencies-when-needed )
16- * [ 6. Build and run your application] ( #6-build-and-run-your-application )
17- * [ 📓 Optional: Run JupyterLab] ( #-optional-run-jupyterlab )
1811* [ 🧠 Vim IDE Features] ( #-vim-ide-features )
19- * [ ✨ Core Capabilities] ( #-core-capabilities )
2012 * [ 🔌Included Plugins] ( #included-plugins )
21- * [ 🧠 Code Intelligence] ( #-code-intelligence )
22- * [ 📁 Navigation & UI] ( #-navigation--ui )
23- * [ 🔄 Git Integration] ( #-git-integration )
24- * [ 📝 Markdown Support] ( #-markdown-support )
25- * [ 📊 Data Science & Python Dev] ( #-data-science--python-dev )
26- * [ 🎨 Theme & Aesthetics] ( #-theme--aesthetics )
27- * [ ⚙️ Python-Specific Tuning] ( #-python-specific-tuning )
2813 * [ 🗂 Additional Notes] ( #-additional-notes )
2914
3015<!-- vim-markdown-toc -->
@@ -71,14 +56,14 @@ Use it as-is or tailor it to match your team's development workflow.
7156
7257## 🚀 Getting Started
7358
74- ### 1. Configure environment and Python settings
59+ 1 . Configure environment and Python settings
7560
7661``` bash
7762cp .env.dist .env
7863vim .env # Set OS packages, Python version, Poetry version, etc.
7964```
8065
81- ### 2. Set up Python project dependencies
66+ 2 . Set up Python project dependencies
8267
8368``` bash
8469vim pyproject.toml # Edit dependencies, metadata, etc.
@@ -87,7 +72,7 @@ docker compose run --rm poetry lock # Generate poetry.lock
8772git add poetry.lock
8873```
8974
90- ### 3. Build your Vim IDE image
75+ 3 . Build your Vim IDE image
9176
9277``` bash
9378cp .vimrc.dist .vimrc
@@ -97,13 +82,13 @@ git config --local user.email you@example.com
9782docker compose build vim-ide
9883```
9984
100- ### 4. Start developing inside the container
85+ 4 . Start developing inside the container
10186
10287``` bash
10388docker compose run --rm vim-ide
10489```
10590
106- ### 5. Update dependencies when needed
91+ 5 . Update dependencies when needed
10792
10893``` bash
10994docker compose run --rm poetry lock
@@ -117,14 +102,14 @@ docker compose build vim-ide
117102docker compose run --rm vim-ide
118103```
119104
120- ### 6. Build and run your application
105+ 6 . Build and run your application
121106
122107``` bash
123108docker compose build app
124109docker compose run --rm app
125110```
126111
127- ### 📓 Optional: Run JupyterLab
112+ 📓 Optional: Run JupyterLab
128113
129114``` bash
130115docker compose build jupyterlab
@@ -138,7 +123,7 @@ This template comes with a thoughtfully configured Vim environment that
138123replicates many features you'd expect from a modern IDE. It’s built for
139124productivity and designed to work out of the box — but is fully customizable.
140125
141- ### ✨ Core Capabilities
126+ ✨ Core Capabilities
142127
143128- ✅ Syntax highlighting & intelligent folding
144129- ✅ Autocompletion and LSP features via ` coc.nvim `
@@ -151,40 +136,40 @@ productivity and designed to work out of the box — but is fully customizable.
151136
152137### 🔌Included Plugins
153138
154- #### 🧠 Code Intelligence
139+ 🧠 Code Intelligence
155140
156141- [ coc.nvim] ( https://github.com/neoclide/coc.nvim ) – LSP engine with autocompletion, diagnostics, and more
157142- [ coc-pyright] ( https://github.com/fannheyward/coc-pyright ) – Python LSP support
158143- [ ultisnips] ( https://github.com/SirVer/ultisnips ) + [ vim-snippets] ( https://github.com/honza/vim-snippets ) – Powerful snippet expansion
159144
160- #### 📁 Navigation & UI
145+ 📁 Navigation & UI
161146
162147- [ NERDTree] ( https://github.com/preservim/nerdtree ) – File tree explorer
163148- [ fzf.vim] ( https://github.com/junegunn/fzf.vim ) – Fuzzy file and symbol search
164149- [ tagbar] ( https://github.com/preservim/tagbar ) – Code structure sidebar
165150- [ vim-airline] ( https://github.com/vim-airline/vim-airline ) ** – Status/tab line enhancement
166151
167- #### 🔄 Git Integration
152+ 🔄 Git Integration
168153
169154- [ vim-fugitive] ( https://github.com/tpope/vim-fugitive ) – Git commands from within Vim
170155- [ vim-gitgutter] ( https://github.com/airblade/vim-gitgutter ) – Git diff signs in the gutter
171156
172- #### 📝 Markdown Support
157+ 📝 Markdown Support
173158
174159- [ vim-markdown] ( https://github.com/plasticboy/vim-markdown ) – Markdown editing enhancements
175160- [ vim-markdown-toc] ( https://github.com/mzlogin/vim-markdown-toc ) – Auto-generated table of contents
176161
177- #### 📊 Data Science & Python Dev
162+ 📊 Data Science & Python Dev
178163
179164- [ vim-slime] ( https://github.com/jpalardy/vim-slime ) – Send code to REPL or terminal
180165- [ vim-doge] ( https://github.com/kkoomen/vim-doge ) – Generate docstrings in Google/Numpy style
181166
182- #### 🎨 Theme & Aesthetics
167+ 🎨 Theme & Aesthetics
183168
184169- [ gruvbox-material] ( https://github.com/sainnhe/gruvbox-material ) – Color scheme (dark, high-contrast)
185170- Airline integrated with Gruvbox
186171
187- ### ⚙️ Python-Specific Tuning
172+ ⚙️ Python-Specific Tuning
188173
189174- Smart indentation for Python, with 4-space formatting
190175- ` textwidth ` and ` colorcolumn ` set to PEP8 defaults
0 commit comments