Skip to content

Commit 0191575

Browse files
committed
Update mkdocs documentation
1 parent 9cacddd commit 0191575

File tree

4 files changed

+9
-3
lines changed

4 files changed

+9
-3
lines changed

docs/example_project.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ cp env.example .env
1111
poetry run python manage.py migrate
1212
poetry run python manage.py runserver
1313
```
14+
15+
See [example](https://github.com/om-proptech/livecomponents/tree/main/example).

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Django Live Components
1+
# Home
22

33
Django Live Component is a library to create dynamic web applications that handle user interaction with the DOM on the server. It relies on Django, HTMX, and Alpine.js to provide a seamless experience for developers and users.
44

docs/uploads.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ Here's an example of how the handler can look:
2626
...
2727
```
2828

29-
You can see a full example in the [uploads](example/uploads) app of the sample project.
29+
You can see a full example in the [uploads](https://github.com/om-proptech/livecomponents/tree/main/example/uploads) app of the sample project.

mkdocs.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
site_name: Django Live Components
2+
site_url: https://om-proptech.github.io/livecomponents/
3+
repo_url: https://github.com/om-proptech/livecomponents
24
nav:
35
- index.md
46
- quickstart.md
@@ -11,7 +13,9 @@ nav:
1113
- Reference:
1214
- decorators.md
1315
- templatetags.md
14-
- Advanced Topics:
16+
- Advanced:
1517
- context.md
1618
- templates.md
1719
- component_ids.md
20+
- About:
21+
- Changelog: https://github.com/om-proptech/livecomponents/blob/main/CHANGELOG.md

0 commit comments

Comments
 (0)