Skip to content

Commit

Permalink
Update dependencies, improve cards and contribs documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
RobertoPrevato committed Dec 23, 2023
1 parent cad5442 commit 37d2e4d
Show file tree
Hide file tree
Showing 6 changed files with 118 additions and 13 deletions.
10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.PHONY: build fixlinks
include .env


build:
Expand All @@ -16,3 +17,12 @@ fixlinks:
clean:
rm -rf site/
rm -rf .build/

# require env variables
publish-dev:
PYAZ_ACCOUNT_KEY=${DEV_ACCOUNT_KEY} pyazblob upload --path .build/ --account-name "neoteroideveuwstacc" -cn "\$$web" -r -f


publish-prod:
PYAZ_ACCOUNT_KEY=${PROD_EUW_ACCOUNT_KEY} pyazblob upload --path .build/ --account-name "neoteroieuwstacc" -cn "\$$web" -r -f
PYAZ_ACCOUNT_KEY=${PROD_USE_ACCOUNT_KEY} pyazblob upload --path .build/ --account-name "neoteroieusstacc" -cn "\$$web" -r -f
70 changes: 70 additions & 0 deletions docs/cards.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,3 +306,73 @@ To display images using background images instead of image elements, use the
image: ../img/icons/007-poseidon.png

::/cards::

## Bigger

::cards:: cols=3 class_name="bigger"

- title: Zeus
content: Lorem ipsum dolor sit amet.
image: ./img/icons/001-zeus.png

- title: Athena
content: Lorem ipsum dolor sit amet.
image: ./img/icons/003-athena.png

- title: Poseidon
content: Lorem ipsum dolor sit amet.
image: ./img/icons/007-poseidon.png

- title: Artemis
content: Lorem ipsum dolor sit amet.
image: ./img/icons/021-artemis.png

- title: Ares
content: Lorem ipsum dolor sit amet.
image: ./img/icons/006-ares.png

- title: Nike
content: Lorem ipsum dolor sit amet.
image: ./img/icons/027-nike.png

::/cards::

## Smaller

<style>
.smaller .nt-card .nt-card-image img {
height: 60px;
}

.smaller .nt-card .nt-card-image {
min-height: 60px;
}
</style>

::cards:: cols=6 class_name="smaller"

- title: Zeus
content: Lorem ipsum dolor sit amet.
image: ./img/icons/001-zeus.png

- title: Athena
content: Lorem ipsum dolor sit amet.
image: ./img/icons/003-athena.png

- title: Poseidon
content: Lorem ipsum dolor sit amet.
image: ./img/icons/007-poseidon.png

- title: Artemis
content: Lorem ipsum dolor sit amet.
image: ./img/icons/021-artemis.png

- title: Ares
content: Lorem ipsum dolor sit amet.
image: ./img/icons/006-ares.png

- title: Nike
content: Lorem ipsum dolor sit amet.
image: ./img/icons/027-nike.png

::/cards::
20 changes: 20 additions & 0 deletions docs/contribs.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,26 @@ following example:

Contributors are matched by email address, and the image is used if configured.

## Adding information with txt files

In some cases contributors information cannot be obtained from Git history:
for example following a history rewrite, or because contributors for a page
are not competent in Git, and contributed in ways that are not visible in the
commit history. For these situations, the contribs plugin supports adding more
information using `*.contribs.txt` files, with a structure like the following:

```
# Comment
Charlie Brown <[email protected]> (3)
Sally Brown <[email protected]> (1)
Roberto Prevato <[email protected]> (10)
```

The name of the .txt files must match the name of the page:

- `example.md`
- `example.contribs.txt`

## Under the hood

This plugin works by using the following `git` commands, to obtain contributors
Expand Down
Empty file modified fixlinks.sh
100644 → 100755
Empty file.
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@ markdown_extensions:
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
Expand Down
27 changes: 16 additions & 11 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@ anyio==3.6.1
azure-common==1.1.25
azure-core==1.25.0
azure-storage-blob==12.3.2
black
certifi==2022.6.15
Babel==2.14.0
black==22.10.0
certifi==2022.12.7
cffi==1.15.1
charset-normalizer==2.1.0
click
click==8.0.4
colorama==0.4.6
commonmark==0.9.1
cryptography==37.0.4
essentials==1.1.5
Expand All @@ -19,26 +21,29 @@ idna==3.3
importlib-metadata==4.12.0
isodate==0.6.1
Jinja2==3.0.3
Markdown==3.3.7
Markdown==3.5.1
MarkupSafe==2.1.1
mergedeep==1.3.4
mkdocs==1.3.1
mkdocs-material==8.3.9
mkdocs-material-extensions==1.0.3
mkdocs==1.5.3
mkdocs-material==9.5.2
mkdocs-material-extensions==1.3.1
msrest==0.7.1
mypy-extensions==0.4.3
neoteroi-mkdocs
neoteroi-mkdocs==1.0.3
oauthlib==3.2.0
packaging==21.3
pathspec==0.9.0
paginate==0.5.6
pathspec==0.12.1
plantuml-markdown==3.6.3
platformdirs==2.5.2
pycparser==2.21
Pygments==2.12.0
pymdown-extensions==9.5
Pygments==2.17.2
pymdown-extensions==10.5
pyparsing==3.0.9
python-dateutil==2.8.2
PyYAML==6.0
pyyaml_env_tag==0.1
regex==2023.10.3
requests==2.28.1
requests-oauthlib==1.3.1
rfc3986==1.5.0
Expand Down

0 comments on commit 37d2e4d

Please sign in to comment.