Skip to content

Commit 3b586fd

Browse files
committed
Update readme with new supported features
1 parent 14d3358 commit 3b586fd

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,29 @@
1-
# Django template LSP
1+
# Django Template Language Server (LSP)
22

3-
A simple Django template LSP for completions that has support for:
3+
The Django Template Language Server (LSP) enhances your Django development
4+
experience with powerful features for navigating and editing template files.
5+
This LSP supports:
6+
7+
### Completions
8+
9+
- **Custom Tags and Filters**: Autocomplete for your custom template tags and filters.
10+
- **Template**: Suggestions for `extends` and `includes` statements.
11+
- **Load Tag**: Autocomplete for `{% load %}` tags.
12+
- **Static Files**: Path suggestions for `{% static %}` tags.
13+
- **URLs**: Autocomplete for `{% url %}` tags.
14+
15+
### Go to Definitions
16+
17+
- **Template**: Jump directly to the templates used in `extends` and `includes`.
18+
- **URL Tag**: Navigate to the views referenced in `{% url %}` tags.
19+
- **Tags and Filters**: Quickly access the definitions of custom tags and filters.
20+
- **Context Variables**: Partial support for jumping to context definitions.
21+
22+
### Hover Documentation
23+
24+
- **URLs**: Inline documentation for `{% url %}` tags.
25+
- **Tags and Filters**: Detailed descriptions for template tags and filters.
426

5-
- Custom `tags` and `filters`
6-
- templates for `extends` and `includes`
7-
- load tag
8-
- static files
9-
- urls
1027

1128
## Support (tested)
1229

@@ -22,7 +39,7 @@ A simple Django template LSP for completions that has support for:
2239

2340
- `docker_compose_file` (string) default: "docker-compose.yml"
2441
- `docker_compose_service` (string) default: "django"
25-
- `django_settings_module` (string) default: ""
42+
- `django_settings_module` (string) default (auto detected when empty): ""
2643

2744
## Type hints
2845

0 commit comments

Comments
 (0)