Skip to content

Commit

Permalink
refactor: better glossary handling
Browse files Browse the repository at this point in the history
  • Loading branch information
gvwilson committed Feb 3, 2024
1 parent 269baef commit 2ef1fbd
Show file tree
Hide file tree
Showing 10 changed files with 237 additions and 110 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ All contributors will be acknowledged.
in `index.md` to include an arbitrary text file *without* automatically including output.
(Note that `single` requires a directory name such as `src` or `out` but `double` does not.)

- Wrap words or phrases in asterisks (e.g., `*word*`) for emphasis;
wrap them in triple underscores (e.g., `___term___`) if they are glossary terms.
- Wrap words or phrases in asterisks (e.g., `*word*`) for *emphasis*.

- Add important terms to `_info/glossary.yml`,
which is in [Glosario][glosario] format.

- Use `{% raw %}<span data-gloss="key">text</span>{% endraw %}` to link to glossary entries.
The key must identify an entry in `_data/glossary.yml`.

- SVG images used in the tutorial are in `img/`
and can be edited using [draw.io][draw-io].
Please use 12-point Helvetica for text.
Expand All @@ -57,7 +59,6 @@ All contributors will be acknowledged.
- `_layouts/`: Jekyll layouts
- `_site/`: Jekyll output (not stored in version control)
- `bin/`: helper programs (e.g., for generating databases)
- `css/`: CSS files for styling site
- `db/`: databases used in examples
- `favicon.ico`: favicon used in generated site
- `img/`: images used in tutorial
Expand All @@ -68,6 +69,7 @@ All contributors will be acknowledged.
- `sql_keywords.txt`: all SQLite keywords
- `out/`: generated output files for examples
- `requirements.txt`: `pip` requirements file to build Python environment
- `res/`: CSS and JavaScript for styling site
- `src/`: source files for examples

## Tags for Issues and Pull Requests
Expand Down
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ release:
.PHONY: lint
lint:
@python bin/lint.py \
--glossary _data/glossary.yml \
--makefile Makefile \
--output ${OUT} \
--page ${PAGE} \
Expand Down
Loading

0 comments on commit 2ef1fbd

Please sign in to comment.