Skip to content

Commit 78faba9

Browse files
authored
📚 Minor README update (#6)
1 parent ebe276a commit 78faba9

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,11 @@ There is already:
4747

4848
This works by using Javascript to add iframe windows for previewing.
4949

50-
This extension adapts the approach of `sphinx-preview`, but:
50+
### Changes to sphinx-preview
5151

52-
1. Replaces the use of jquery with vanilla JavaScript
52+
This extension adapts the approach of `sphinx-preview`, but makes some changes including:
53+
54+
1. Replaces the use of JQuery with vanilla JavaScript
5355
2. Always uses clickable icons to show the preview window, rather than mouseover hover (I feel this gives the user more control, and understanding of which links are preview-able)
5456
3. Fixes some bugs with the scroll-to-anchor behaviour, and preview window positioning
5557
4. Adds anchoring of the preview window to the reference, during scrolling and window resizing

0 commit comments

Comments
 (0)