Skip to content

Commit

Permalink
Initial
Browse files Browse the repository at this point in the history
  • Loading branch information
maouw committed Dec 7, 2023
1 parent a06e5ad commit bbe25ca
Show file tree
Hide file tree
Showing 36 changed files with 329 additions and 5,789 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/quarto-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
on:
push:
branches: main

name: Render with Quarto and Publish

# you need these permissions to publish to GitHub pages
permissions:
contents: write
pages: write

jobs:
build-deploy:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2
- name: Publish to GitHub Pages (and render)
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # this secret is always available for github actions
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,6 @@
.quarto

/.quarto/

/.luarc.json
_site/
9 changes: 6 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ authors:
- family-names: DeBruine
given-names: Lisa
orcid: https://orcid.org/0000-0002-7523-5539
title: "Quarto Glossary"
version: 0.0.9001
date-released: 2023-11-28
- family-names: Orhon
given-names: Altan
orcid: https://orcid.org/0000-0002-4412-5580
title: "Quarto Popover Glossary"
version: 0.0.9002
date-released: 2023-12-06
1 change: 1 addition & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# MIT License

Copyright (c) 2023 Lisa DeBruine
Copyright (c) 2023 Altan Orhon

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,16 @@
# Glossary Extension for Quarto
# Popover Glossary Extension for Quarto

This extension provides shortcodes for [popover-glossary](https://github.com/maouw/quarto-popover-glossary) in quarto. It uses the [Popper](https://popper.js.org) library to create popovers with glossary definitions. You can use this to mark terms in your text, which can display a popup definition, and to create definition list of terms at the end of a document.

This extension provides shortcodes for defining terms and creating glossaries
in quarto. You can use this to mark terms in your text, which can display a popup
definition, and to create table of defined terms at the end of a document.
[popover-glossary](https://github.com/maouw/quarto-popover-glossary) is based on [quarto-glossary](https://debruine.github.io/quarto-glossary) by [Lisa DeBruine](https://debruine.github.io/). Most code and documentation, including the majority of this web page, is from [quarto-glossary](https://debruine.github.io/quarto-glossary).

See <https://debruine.github.io/quarto-glossary> for examples.
See <https://maouw.github.io/quarto-popover-glossary> for examples.

## Installing

```sh
quarto install extension debruine/quarto-glossary
quarto install extension maouw/quarto-popover-glossary
```

This will install the extension under the `_extensions` subdirectory.
If you're using version control, you will want to check in this directory.



7 changes: 0 additions & 7 deletions _extensions/glossary/_extension.yml

This file was deleted.

56 changes: 0 additions & 56 deletions _extensions/glossary/glossary.css

This file was deleted.

174 changes: 0 additions & 174 deletions _extensions/glossary/glossary.lua

This file was deleted.

7 changes: 7 additions & 0 deletions _extensions/popover-glossary/_extension.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
title: Popover Glossary
author: Altan Orhon
version: 1.0.0
quarto-required: ">=1.2.0"
contributes:
shortcodes:
- popover-glossary.lua
44 changes: 44 additions & 0 deletions _extensions/popover-glossary/popover-glossary.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
/* glossary deflist styles */
.glossary_dl {
font-size: 95%;
}

.glossary_dl dt {
font-weight: bold;
}
.glossary_dl dd {
margin-left: 1em;
line-height: normal;
text-indent: 2em;
text-align: justify;
border-top: 1px dotted var(--quarto-body-color);
}

.glossary-ref {
cursor: pointer;
display: inline;
border-style: hidden;
}

.glossary-def {
/* background-color: var(--quarto-body-color);*/
background-color: var(--quarto-body-bg);
opacity: 1;
color: var(--quarto-body-color);
font-size: 75%;
display: none;
z-index: 1000;
max-width: 33%;
border-color: var(--quarto-border-color);
border-width: 1px;
border-style: solid;
box-shadow: 2px 2px var(--quarto-body-color);
padding: 0.5em;
outline: 1px dotted var(--quarto-body-color);
outline-offset: -2px;
text-align: justify;
}

.glossary-def[data-show] {
display: block;
}
Loading

0 comments on commit bbe25ca

Please sign in to comment.