Skip to content

Commit

Permalink
Update htmx documentation links (#499)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Carlton Gibson <[email protected]>
Co-authored-by: Adam Johnson <[email protected]>
  • Loading branch information
3 people authored Dec 30, 2024
1 parent e18a0c8 commit 82c7feb
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ Changelog
* Support the ``HX-History-Restore-Request`` header, which was added in htmx 1.2.0.
This is parsed into the ``request.htmx.history_restore_request`` attribute.

* Support the ``Triggering-Event`` header, which is sent by the `event-header extension <https://htmx.org/extensions/event-header/>`__.
* Support the ``Triggering-Event`` header, which is sent by the `event-header extension <https://github.com/bigskysoftware/htmx-extensions/blob/main/src/event-header/README.md>`__.
This is parsed into the ``request.htmx.triggering_event`` attribute.

* Stop distributing tests to reduce package size.
Expand Down
2 changes: 1 addition & 1 deletion docs/extension_script.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,4 @@ See this in action in the “Error Demo” section of the :doc:`example project

.. hint::

This extension script should not be confused with htmx’s `debug extension <https://htmx.org/extensions/debug/>`__, which logs DOM events in the browser console.
This extension script should not be confused with htmx’s `debug extension <https://github.com/bigskysoftware/htmx-extensions/blob/main/src/debug/README.md>`__, which logs DOM events in the browser console.
2 changes: 1 addition & 1 deletion docs/middleware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -152,4 +152,4 @@ Middleware
:type: Any | None

The deserialized JSON representation of the event that triggered the request if it exists, or ``None``.
This header is set by the `event-header htmx extension <https://htmx.org/extensions/event-header/>`__, and contains details of the DOM event that triggered the request.
This header is set by the `event-header htmx extension <https://github.com/bigskysoftware/htmx-extensions/blob/main/src/event-header/README.md>`__, and contains details of the DOM event that triggered the request.
2 changes: 1 addition & 1 deletion example/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ Open it at http://127.0.0.1:8000/ .

Browse the individual examples, and take them apart!

In your browser’s devtools, you can read the htmx `debug log <https://htmx.org/extensions/debug/>`__ in your browser’s console, and see the requests made in the network tab.
In your browser’s devtools, you can read the htmx `debug log <https://github.com/bigskysoftware/htmx-extensions/blob/main/src/debug/README.md>`__ in your browser’s console, and see the requests made in the network tab.
In the source code, check out the HTML comments via “view source” or templates, and the view code in ``example/views.py``.
4 changes: 2 additions & 2 deletions example/example/templates/_base.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@

<!--
Enable htmx extensions for all requests:
* debug: https://htmx.org/extensions/debug/
* event-header: https://htmx.org/extensions/event-header/
* debug: https://github.com/bigskysoftware/htmx-extensions/blob/main/src/debug/README.md
* event-header: https://github.com/bigskysoftware/htmx-extensions/blob/main/src/event-header/README.md
-->
<body hx-ext="debug, event-header">
<header>
Expand Down
2 changes: 1 addition & 1 deletion example/example/templates/middleware-tester-table.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
<tr>
<td>
<code>request.htmx.triggering_event</code> <br>
<small>(via <a href="https://htmx.org/extensions/event-header/">event-header extension</a>)</small>
<small>(via <a href="https://github.com/bigskysoftware/htmx-extensions/blob/main/src/event-header/README.md">event-header extension</a>)</small>
</td>
<td>
{% if request.htmx.triggering_event %}
Expand Down

0 comments on commit 82c7feb

Please sign in to comment.