Skip to content

Commit

Permalink
feat: filling in colophon and adding to navigation
Browse files Browse the repository at this point in the history
  • Loading branch information
gvwilson committed Feb 4, 2024
1 parent eb81af0 commit fd09791
Show file tree
Hide file tree
Showing 7 changed files with 39 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@
[conduct]: https://gvwilson.github.io/sql-tutorial/conduct/
[contribute]: https://gvwilson.github.io/sql-tutorial/contributing/
[license]: https://gvwilson.github.io/sql-tutorial/license/
[release]: https://github.com/gvwilson/sql-tutorial/blob/main/sql-tutorial.zip
[release]: https://github.com/gvwilson/sql-tutorial/raw/main/sql-tutorial.zip
[site]: https://gvwilson.github.io/sql-tutorial/
2 changes: 1 addition & 1 deletion _data/meta.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
title: SQL for Data Scientists in 100 Queries
url: https://gvwilson.github.io/sql-tutorial/
repo: https://github.com/gvwilson/sql-tutorial
release: https://github.com/gvwilson/sql-tutorial/raw/main/sql-tutorial.zip
plausible: gvwilson.github.io/sql-tutorial

author:
name: Greg Wilson
url: https://third-bit.com
Expand Down
22 changes: 0 additions & 22 deletions _includes/colophon.md

This file was deleted.

2 changes: 2 additions & 0 deletions _includes/nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
</div>
<div class="col-10 right">
<a href="{{site.data.meta.repo}}">repo</a>
<a href="{{site.data.meta.release}}">download</a>
<a class="navlink" href="{{ '/license/' | relative_url }}">license</a>
<a class="navlink" href="{{ '/conduct/' | relative_url }}">conduct</a>
<a class="navlink" href="{{ '/contributing/' | relative_url }}">contributing</a>
<a class="navlink" href="{{ '/colophon/' | relative_url }}">colophon</a>
</div>
</div>
</nav>
33 changes: 33 additions & 0 deletions colophon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Colophon
permalink: /colophon/
---

The tutorial text uses [Atkinson Hyperlegible][atkinson],
which was designed to be easy for people with impaired vision to read.
Code uses Source Code Pro and diagrams use Helvetica.

The CSS files used to style code were obtained from [highlight-css][highlight-css].
This site uses the `github` style for [Rouge][rouge];
legibility was checked using [WebAIM WAVE][wave].

Diagrams were created with the desktop version of [draw.io][draw-io].

The site is built using [Jekyll][jekyll]
and hosted on [GitHub Pages][ghp].
Traffic statistics are collected using [plausible.io][plausible],
which provides a lightweight ethical alternative to surveillance capitalism.

The colors in this theme
are lightened versions of those used in
[classic Canadian postage stamps][stamps].

[atkinson]: https://brailleinstitute.org/freefont
[draw-io]: https://www.drawio.com/
[ghp]: https://pages.github.com/
[highlight-css]: https://numist.github.io/highlight-css/
[jekyll]: https://jekyllrb.com/
[plausible]: https://plausible.io/
[rouge]: https://rouge.jneen.net/
[stamps]: https://third-bit.com/colophon/
[wave]: https://wave.webaim.org/
5 changes: 1 addition & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ home: true

## setup

- Download [the latest release][release]
- Download [the latest release]({{site.data.meta.release}})
- Unzip the file in a temporary directory to create:
- `./db/*.db`: the SQLite databases used in the examples
- `./src/*.*`: SQL queries, Python scripts, and other source code
Expand Down Expand Up @@ -1460,8 +1460,6 @@ I would also like to thank the following for spotting issues, making suggestions

{% include thanks.html %}

{% include colophon.md %}

</section>

[albrecht-andi]: http:https://andialbrecht.de/
Expand All @@ -1472,7 +1470,6 @@ I would also like to thank the following for spotting issues, making suggestions
[mongodb]: https://www.mongodb.com/
[persona]: http:https://teachtogether.tech/en/index.html#s:process-personas
[postgresql]: https://www.postgresql.org/
[release]: https://github.com/{{site.repository}}/raw/main/sql-tutorial.zip
[sql]: https://en.wikipedia.org/wiki/SQL
[sqlite]: https://sqlite.org/
[sqlparse]: https://pypi.org/project/sqlparse/
Expand Down
1 change: 1 addition & 0 deletions misc/tutorial.mk
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ template:
bin/ordered.py \
bin/renumber_headings.py \
bin/lint.py \
colophon.md \
conduct_.md \
contributing_.md \
favicon.ico \
Expand Down

0 comments on commit fd09791

Please sign in to comment.