Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tile API Update #123

Merged
merged 69 commits into from
Feb 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
e90b5cc
bump to 4.0.0
ntno Feb 1, 2023
d4108fa
proposed api change
ntno Feb 1, 2023
2ec5780
formatting
ntno Feb 1, 2023
f6fbd25
refactor wip
ntno Feb 1, 2023
73c2078
test refactor
ntno Feb 1, 2023
08e803d
wip
ntno Feb 1, 2023
56cc99d
wip
ntno Feb 1, 2023
74b8c33
wip
ntno Feb 1, 2023
6a25813
wip
ntno Feb 1, 2023
c1b5184
wip
ntno Feb 1, 2023
393b1bc
wip
ntno Feb 1, 2023
b6e4e76
wip
ntno Feb 1, 2023
dd015b9
wip
ntno Feb 1, 2023
2a3dba7
wip
ntno Feb 1, 2023
dcdeacc
formatting
ntno Feb 1, 2023
cbdf0cf
wip
ntno Feb 1, 2023
dd6c613
wip
ntno Feb 1, 2023
3963d30
wip
ntno Feb 1, 2023
c5172a3
put tests back
ntno Feb 1, 2023
e052dd4
refactor
ntno Feb 1, 2023
6b69ae7
api update
ntno Feb 2, 2023
13577fd
update api
ntno Feb 2, 2023
d73c88d
standardize
ntno Feb 2, 2023
cc05393
update test setup
ntno Feb 2, 2023
ad27c2d
change text to alt_text and title to tooltip
ntno Feb 2, 2023
32a3d75
Doc updates for api change (#124)
ntno Feb 2, 2023
1814eff
reorder
ntno Feb 2, 2023
cf7d667
add alt text
ntno Feb 2, 2023
7efeb61
add info on alt text
ntno Feb 2, 2023
d441e17
formatting
ntno Feb 2, 2023
3aba6ea
formatting, remove extra link
ntno Feb 2, 2023
015f9ad
doc update
ntno Feb 2, 2023
dfb4966
doc update / formatting
ntno Feb 2, 2023
9a0832b
formatting
ntno Feb 2, 2023
3cc7cad
update example (wip)
ntno Feb 2, 2023
ecdaaee
wip
ntno Feb 2, 2023
f8abe8b
less is more (wip)
ntno Feb 2, 2023
4a8d3a0
less is more (wip)
ntno Feb 2, 2023
ccfe1af
remove width/height attributes
ntno Feb 2, 2023
bf95a9d
refactor css
ntno Feb 2, 2023
a36968c
simplify example
ntno Feb 2, 2023
4520868
add comments, add license info, remove flexbox
ntno Feb 2, 2023
23b6984
in page styles win out, don't need to override with important tag
ntno Feb 2, 2023
bd68c60
typo fix
ntno Feb 2, 2023
f3d49a3
remove border important flag on default tile
ntno Feb 2, 2023
de9caf4
dont need important tag anymore
ntno Feb 2, 2023
e4bb1b6
formatting, add detail
ntno Feb 2, 2023
35dc70f
formatting
ntno Feb 2, 2023
8cb97f1
reorder attributes (hopefully improves markdown readability?)
ntno Feb 2, 2023
79a638d
update example palette pages for new alt_text guidelines (alt_text sh…
ntno Feb 2, 2023
297ac09
revert name change
ntno Feb 2, 2023
857000c
reran test coverage
ntno Feb 2, 2023
6610692
rename css class
ntno Feb 2, 2023
663c135
shorten alt text
ntno Feb 2, 2023
1d4fada
update alt text
ntno Feb 2, 2023
569e2c3
alt update
ntno Feb 2, 2023
95e083b
simplify example
ntno Feb 2, 2023
4612361
formatting
ntno Feb 2, 2023
9d33a1a
remove extra tooltips
ntno Feb 2, 2023
cfbce5d
remove unecessary link
ntno Feb 2, 2023
311344f
remove unused links
ntno Feb 2, 2023
4554547
formatting
ntno Feb 2, 2023
6136b06
update
ntno Feb 3, 2023
c8158ac
update
ntno Feb 3, 2023
50909b6
rename
ntno Feb 3, 2023
2d98784
fix example markdown
ntno Feb 3, 2023
3be6021
wip
ntno Feb 3, 2023
b0033d2
update
ntno Feb 3, 2023
664d179
formatting
ntno Feb 3, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/docs/about/coverage-report/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h1>Coverage report:
</form>
<p class="text">
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v7.1.0</a>,
created at 2023-01-31 04:48 +0000
created at 2023-02-02 22:00 +0000
</p>
</div>
</header>
Expand Down Expand Up @@ -158,7 +158,7 @@ <h1>Coverage report:
<div class="content">
<p>
<a class="nav" href="https://coverage.readthedocs.io">coverage.py v7.1.0</a>,
created at 2023-01-31 04:48 +0000
created at 2023-02-02 22:00 +0000
</p>
</div>
<aside class="hidden">
Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/configuration/palettes/dark.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/configuration/palettes/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/configuration/palettes/gruvbox-dark.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

Expand Down
48 changes: 24 additions & 24 deletions documentation/docs/configuration/palettes/index.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
---
show_tiles_first: true
tiles:
- caption: <a id="fnref:1" class="footnote-ref" title="to image description" alt="to long image description" href="#fn:1">Default</a>
- caption: <a id="fnref:1" class="footnote-ref" title="to image description" alt="to Default palette description." href="#fn:1">Default</a>
img_src: ../../img/palettes/default.png
img_title: to Default Demo Page
img_alt: Default Demo Page
tooltip: to Default Demo Page
alt_text: Default Demo Page
link_href: ./default/
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to long image description" href="#fn:2">Gruvbox Dark</a>
- caption: <a id="fnref:2" class="footnote-ref" title="to image description" alt="to Gruvbox Dark palette description." href="#fn:2">Gruvbox Dark</a>
img_src: ../../img/palettes/gruvbox_dark.png
img_title: to Gruvbox Dark Demo Page
img_alt: Gruvbox Dark Demo Page
tooltip: to Gruvbox Dark Demo Page
alt_text: Gruvbox Dark Demo Page
link_href: ./gruvbox-dark/
- caption: <a id="fnref:3" class="footnote-ref" title="to image description" alt="to long image description" href="#fn:3">Dark</a>
- caption: <a id="fnref:3" class="footnote-ref" title="to image description" alt="to Dark palette description." href="#fn:3">Dark</a>
img_src: ../../img/palettes/dark.png
img_title: to Dark Demo Page
img_alt: Dark Demo Page
tooltip: to Dark Demo Page
alt_text: Dark Demo Page
link_href: ./dark/
- caption: <a id="fnref:4" class="footnote-ref" title="to image description" alt="to long image description" href="#fn:4">Pink</a>
- caption: <a id="fnref:4" class="footnote-ref" title="to image description" alt="to Pink palette description." href="#fn:4">Pink</a>
img_src: ../../img/palettes/pink.png
img_title: to Pink Demo Page
img_alt: Pink Demo Page
tooltip: to Pink Demo Page
alt_text: Pink Demo Page
link_href: ./pink/
- caption: <a id="fnref:5" class="footnote-ref" title="to image description" alt="to long image description" href="#fn:5">Sans</a>
- caption: <a id="fnref:5" class="footnote-ref" title="to image description" alt="to Sans palette description." href="#fn:5">Sans</a>
img_src: ../../img/palettes/sans.png
img_title: to Sans Demo Page
img_alt: Sans Demo Page
tooltip: to Sans Demo Page
alt_text: Sans Demo Page
link_href: ./sans/
- caption: <a id="fnref:6" class="footnote-ref" title="to image description" alt="to long image description" href="#fn:6">Sans Dark</a>
- caption: <a id="fnref:6" class="footnote-ref" title="to image description" alt="to Sans Dark palette description." href="#fn:6">Sans Dark</a>
img_src: ../../img/palettes/sans_dark.png
img_title: to Sans Dark Demo Page
img_alt: Sans Dark Demo Page
tooltip: to Sans Dark Demo Page
alt_text: Sans Dark Demo Page
link_href: ./sans-dark/
---

Expand All @@ -51,9 +51,9 @@ theme:
palette: pink
```

[^1]: demo site with a white background and light blue hyperlinks.
[^2]: demo site with a dark grey background, orange hyperlinks, and light yellow text.
[^3]: demo site with a black background, light blue hyperlinks, and white text.
[^4]: demo site with a white background and pink hyperlinks.
[^5]: demo site with a white background, light blue hyperlinks, and sans font.
[^6]: demo site with a black background, light blue hyperlinks, and white text in sans font.
[^1]: white background and light blue hyperlinks.
[^2]: dark grey background, orange hyperlinks, and light yellow text.
[^3]: black background, light blue hyperlinks, and white text.
[^4]: white background and pink hyperlinks.
[^5]: white background, light blue hyperlinks, and sans font.
[^6]: black background, light blue hyperlinks, and white text in sans font.
12 changes: 6 additions & 6 deletions documentation/docs/configuration/palettes/pink.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/configuration/palettes/sans-dark.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/configuration/palettes/sans.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

Expand Down
4 changes: 1 addition & 3 deletions documentation/docs/elements/examples/figure.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
## Figure Example

<section markdown>
<figure markdown>
![some image](https://picsum.photos/1000/600?random&imageWithCaption){ title="a random image" ; alt="Random image with a caption" }
![some image](https://picsum.photos/1000/600?random&imageWithCaption){ title="a random image" alt="randomly generated image." }
<figcaption>A Random Image</figcaption>
</figure>
</section>

<br>
8 changes: 2 additions & 6 deletions documentation/docs/elements/figure.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,19 @@ markdown_extensions:

## Example

<section markdown>
<figure markdown>
![some image](../img/picsum/120_small.jpg){ title="a starry night" ; alt="a dark sky filled with stars" }
![some image](../img/picsum/120_small.jpg){ title="a starry night" alt="a dark green sky filled with stars." }
<figcaption>@Guillaume via Picsum</figcaption>
</figure>
</section>


### Markdown

```markdown
<section markdown>
<figure markdown>
![some image](../img/picsum/120_small.jpg){ title="a starry night" ; alt="a dark sky filled with stars" }
![some image](../img/picsum/120_small.jpg){ title="a starry night" alt="a dark green sky filled with stars." }
<figcaption>@Guillaume via Picsum</figcaption>
</figure>
</section>
```


Expand Down
12 changes: 6 additions & 6 deletions documentation/docs/tile-grid/examples/example-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
- caption: 'Steve Richey'
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
tooltip: 'to Picsum homepage'
alt_text: 'Picsum Photo API.'
link_href: https://picsum.photos/
---

Expand Down
16 changes: 10 additions & 6 deletions documentation/docs/tile-grid/examples/images-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,22 @@ show_tiles_first: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
alt_text: 'close up of fallen leaves.'
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
- caption: 'Steve Richey'
alt_text: 'close up of green moss on a log.'
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
alt_text: 'overhead of fallen leaves.'
---

# Image Only Tiles
The tiles on this page do not have `link_*` attributes[^tile-reference]. They are rendered as a captioned images instead of linked images.
The tiles on this page do not have a `link_href` attribute. They are rendered as static images instead of linked images.

# Tiles First
The tiles on this page are placed before the main page content. This is because the [grid option](../grid.md) `show_tiles_first` is set to `true`.

[^tile-reference]: see [Tile Reference](../tile.md)



## Markdown

```markdown
Expand All @@ -26,9 +27,12 @@ show_tiles_first: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
alt_text: 'close up of fallen leaves.'
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
- caption: 'Steve Richey'
alt_text: 'close up of green moss on a log.'
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
alt_text: 'overhead of fallen leaves.'
---
```
12 changes: 3 additions & 9 deletions documentation/docs/tile-grid/examples/inline.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,13 @@ show_tiles_inline: true
tiles:
- caption: '@petradr'
img_src: ../../../img/picsum/167_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of fallen leaves.'
link_href: https://picsum.photos/
alt_text: 'close up of fallen leaves.'
- caption: 'Marcin Czerwinski'
img_src: ../../../img/picsum/127_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'close up of green moss on a log.'
link_href: https://picsum.photos/
alt_text: 'close up of green moss on a log.'
- caption: "Steve Richey"
img_src: ../../../img/picsum/143_200x200.jpeg
img_title: 'to Picsum homepage'
img_alt: 'overhead of fallen leaves.'
link_href: https://picsum.photos/
alt_text: 'overhead of fallen leaves.'
---

# My Page Content
Expand Down
Loading