Skip to content

Commit 09b2769

Browse files
committed
Update docs
- Update theme - Use a more common admonition/details convention - Update copyright
1 parent c6e80fc commit 09b2769

File tree

14 files changed

+169
-224
lines changed

14 files changed

+169
-224
lines changed

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2018 - 2025 Isaac Muse <isaacmuse@gmail.com>
3+
Copyright (c) 2018 - 2026 Isaac Muse <isaacmuse@gmail.com>
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

docs/src/markdown/about/changelog.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ icon: lucide/scroll-text
77

88
- **FIX**: Ensure custom selectors or namespace dictionaries reject non-string keys (@mundanevision20).
99
- **FIX**: Fix handling of `:in-range` and `:out-of-range` with end of year weeks (@mundanevision20).
10-
- **FIX**: Fix a potential infinite loop in pretty printing of compiled selector objects (@mundanevision20).
10+
- **FIX**: Fix a potential infinite loop in pretty printing debug function (@mundanevision20).
1111

1212
## 2.8.1
1313

@@ -120,8 +120,7 @@ icon: lucide/scroll-text
120120

121121
## 1.9.6
122122

123-
/// note | Last version for Python 2.7
124-
///
123+
> [!note] Last version for Python 2.7
125124
126125
- **FIX**: Prune dead code.
127126
- **FIX**: Corner case with splitting namespace and tag name that have an escaped `|`.

docs/src/markdown/about/development.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,7 @@ Documents are in Markdown (with some additional syntax provided by extensions) a
4040
Markdown. If you would like to build and preview the documentation, you must have these packages installed:
4141

4242
- @Python-Markdown/markdown: the Markdown parser.
43-
- @mkdocs/mkdocs: the document site generator.
44-
- @squidfunk/mkdocs-material: a material theme for MkDocs.
43+
- @zensical/zensical: the document site generator.
4544
- @facelessuser/pymdown-extensions: this Python Markdown extension bundle.
4645

4746
It is advised that you just install document dependencies with the following as the above list may not include all
@@ -56,7 +55,7 @@ able to view the documents at `localhost:8000` in your browser. After that, you
5655
and have your browser preview update live.
5756

5857
```
59-
mkdocs serve
58+
python3 -m zensical serve -f zensical.yml
6059
```
6160

6261
## Spell Checking Documents
@@ -75,7 +74,7 @@ run the following command from the root of the project.
7574
You will need to make sure the documents are built first:
7675

7776
```
78-
mkdocs build --clean
77+
python3 -m zensical build --clean -f zensical.yml
7978
```
8079

8180
And then run the spell checker.

docs/src/markdown/api.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,12 @@ change.
2323
parser). Some additional configuration is required when using namespaces, see [Namespace](#namespaces) for more
2424
information.
2525

26-
/// tip | Getting Proper Namespaces
27-
The `html5lib` parser provides proper namespaces for HTML5, but `lxml`'s HTML parser will not. If you need
28-
namespace support for HTML5, consider using `html5lib`.
29-
30-
For XML, the `lxml-xml` parser (`xml` for short) will provide proper namespaces. It is generally suggested that
31-
`lxml-xml` is used to parse XHTML documents to take advantage of namespaces.
32-
///
26+
> [!tip] Getting Proper Namespaces
27+
> The `html5lib` parser provides proper namespaces for HTML5, but `lxml`'s HTML parser will not. If you need
28+
> namespace support for HTML5, consider using `html5lib`.
29+
>
30+
> For XML, the `lxml-xml` parser (`xml` for short) will provide proper namespaces. It is generally suggested that
31+
> `lxml-xml` is used to parse XHTML documents to take advantage of namespaces.
3332
3433
- While attribute values are generally treated as case sensitive, HTML5 and HTML treat the `type` attribute
3534
special. The `type` attribute's value is always case insensitive. This is generally how most browsers treat `type`.
@@ -184,9 +183,8 @@ would normally cause an identifier to be invalid.
184183
'�'
185184
```
186185

187-
/// new | New in 1.9.0
188-
`escape` is a new API function added in 1.9.0.
189-
///
186+
> [!new] New in 1.9.0
187+
> `escape` is a new API function added in 1.9.0.
190188
191189
## `soupsieve.compile()`
192190

docs/src/markdown/faq.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@ feature that Soup Sieve cannot/will not support, see [Beautiful Soup Differences
1717

1818
## How does `iframe` handling work?
1919

20-
/// note
21-
Recent versions of Python's `html.parser`, `lxml`, and `html5lib` all seem to escape `iframe` content.
22-
///
20+
> [!note]
21+
> Recent versions of Python's `html.parser`, `lxml`, and `html5lib` all seem to escape `iframe` content.
2322
2423
In web browsers, CSS selectors do not usually select content inside an `iframe` element if the selector is called on an
2524
element outside of the `iframe`. Each HTML document is usually encapsulated and CSS selector leakage across this

docs/src/markdown/selectors/basic.md

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,8 @@ element
4747
```
4848
///
4949

50-
/// tip | Additional Reading
51-
https://developer.mozilla.org/en-US/docs/Web/CSS/Type_selectors
52-
///
50+
> [!tip] Additional Reading
51+
> https://developer.mozilla.org/en-US/docs/Web/CSS/Type_selectors
5352

5453
## Universal Selectors
5554

@@ -90,9 +89,8 @@ The Universal selector (`*`) matches elements of any type.
9089
```
9190
///
9291

93-
/// tip | Additional Reading
94-
https://developer.mozilla.org/en-US/docs/Web/CSS/Universal_selectors
95-
///
92+
> [!tip] Additional Reading
93+
> https://developer.mozilla.org/en-US/docs/Web/CSS/Universal_selectors
9694

9795
## ID Selectors
9896

@@ -122,14 +120,12 @@ The ID selector matches an element based on its `id` attribute. The ID must matc
122120
```
123121
///
124122

125-
/// tip | Additional Reading
126-
https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors
127-
///
123+
> [!tip] Additional Reading
124+
> https://developer.mozilla.org/en-US/docs/Web/CSS/ID_selectors
128125

129-
/// note | XML Support
130-
While the use of the `id` attribute (in the context of CSS) is a very HTML centric idea, it is supported for XML as
131-
well because Beautiful Soup supported it before Soup Sieve's existence.
132-
///
126+
> [!note] XML Support
127+
> While the use of the `id` attribute (in the context of CSS) is a very HTML centric idea, it is supported for XML as
128+
> well because Beautiful Soup supported it before Soup Sieve's existence.
133129

134130
## Class Selectors
135131

@@ -160,23 +156,20 @@ treated as a whitespace separated list, where each item is a **class**.
160156
```
161157
///
162158

163-
/// tip | Additional Reading
164-
https://developer.mozilla.org/en-US/docs/Web/CSS/Class_selectors
165-
///
159+
> [!tip] Additional Reading
160+
> https://developer.mozilla.org/en-US/docs/Web/CSS/Class_selectors
166161

167-
/// note | XML Support
168-
While the use of the `class` attribute (in the context of CSS) is a very HTML centric idea, it is supported for XML
169-
as well because Beautiful Soup supported it before Soup Sieve's existence.
170-
///
162+
> [!note] XML Support
163+
> While the use of the `class` attribute (in the context of CSS) is a very HTML centric idea, it is supported for XML
164+
> as well because Beautiful Soup supported it before Soup Sieve's existence.
171165

172166
## Attribute Selectors
173167

174168
The attribute selector matches an element based on its attributes. When specifying a value of an attribute, if it
175169
contains whitespace or special characters, you should quote them with either single or double quotes.
176170

177-
/// tip | Additional Reading
178-
https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors
179-
///
171+
> [!tip] Additional Reading
172+
> https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors
180173

181174
/// define |
182175
`[attribute]`

docs/src/markdown/selectors/combinators.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,8 @@ parent descendant
6060
```
6161
///
6262

63-
/// tip | Additional Reading
64-
https://developer.mozilla.org/en-US/docs/Web/CSS/Descendant_combinator
65-
///
63+
> [!tip] Additional Reading
64+
> https://developer.mozilla.org/en-US/docs/Web/CSS/Descendant_combinator
6665

6766
## Child combinator
6867

@@ -93,9 +92,8 @@ parent > child
9392
```
9493
///
9594

96-
/// tip | Additional Reading
97-
https://developer.mozilla.org/en-US/docs/Web/CSS/Child_combinator
98-
///
95+
> [!tip] Additional Reading
96+
> https://developer.mozilla.org/en-US/docs/Web/CSS/Child_combinator
9997

10098
## General sibling combinator
10199

@@ -127,9 +125,8 @@ prevsibling ~ sibling
127125
```
128126
///
129127

130-
/// tip | Additional Reading
131-
https://developer.mozilla.org/en-US/docs/Web/CSS/General_sibling_combinator
132-
///
128+
> [!tip] Additional Reading
129+
> https://developer.mozilla.org/en-US/docs/Web/CSS/General_sibling_combinator
133130

134131
## Adjacent sibling combinator
135132

@@ -161,9 +158,8 @@ prevsibling + nextsibling
161158
```
162159
///
163160

164-
/// tip | Additional Reading
165-
https://developer.mozilla.org/en-US/docs/Web/CSS/Adjacent_sibling_combinator
166-
///
161+
> [!tip] Additional Reading
162+
> https://developer.mozilla.org/en-US/docs/Web/CSS/Adjacent_sibling_combinator
167163

168164
--8<--
169165
selector_styles.md

docs/src/markdown/selectors/index.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -67,23 +67,22 @@ cases, we may adopt them as "custom" selectors.
6767
</tr>
6868
</table>
6969

70-
/// tip | Additional Reading
71-
If usage of a selector is not clear in this documentation, you can find more information by reading these
72-
specification documents:
73-
74-
[CSS Level 3 Specification](https://www.w3.org/TR/selectors-3/)
75-
: Contains the latest official document outlying official behaviors of CSS selectors.
76-
77-
[CSS Level 4 Working Draft](https://www.w3.org/TR/selectors-4/)
78-
: Contains the latest published working draft of the CSS level 4 selectors which outlines the experimental new
79-
selectors and experimental behavioral changes.
80-
81-
[HTML5](https://www.w3.org/TR/html50/)
82-
: The HTML 5.0 specification document. Defines the semantics regarding HTML.
83-
84-
[HTML Living Standard](https://html.spec.whatwg.org/)
85-
: The HTML Living Standard document. Defines semantics regarding HTML.
86-
///
70+
> [!tip] Additional Reading
71+
> If usage of a selector is not clear in this documentation, you can find more information by reading these
72+
> specification documents:
73+
>
74+
> [CSS Level 3 Specification](https://www.w3.org/TR/selectors-3/)
75+
> : Contains the latest official document outlying official behaviors of CSS selectors.
76+
>
77+
> [CSS Level 4 Working Draft](https://www.w3.org/TR/selectors-4/)
78+
> : Contains the latest published working draft of the CSS level 4 selectors which outlines the experimental new
79+
> selectors and experimental behavioral changes.
80+
>
81+
> [HTML5](https://www.w3.org/TR/html50/)
82+
> : The HTML 5.0 specification document. Defines the semantics regarding HTML.
83+
>
84+
> [HTML Living Standard](https://html.spec.whatwg.org/)
85+
> : The HTML Living Standard document. Defines semantics regarding HTML.
8786
8887
## Selector Terminology
8988

0 commit comments

Comments
 (0)