Skip to content

Commit

Permalink
feat: Implementation for mkdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
TEParsons committed Mar 30, 2024
1 parent b338200 commit 013f561
Show file tree
Hide file tree
Showing 17 changed files with 217 additions and 0 deletions.
12 changes: 12 additions & 0 deletions mkdocs/example/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
theme:
name: null
custom_dir: '../torillic'
features:
- navigation.pathnavigation
site_name: Torillic MkDocs Example Wiki
docs_dir: src
nav:
- Home: index.md
- Geese: geese/index.md
exclude_docs: |
desktop.ini
29 changes: 29 additions & 0 deletions mkdocs/example/src/geese/Asparagoose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Asparagoose

![Asparagoose](asparagoose.png)

> | STR | CON | DEX | INT | WIS | CHA |
> | ---- | ---- | ---- | ---- | ---- | ---- |
> | -1 | +0 | +0 | -4 | +1 | +1 |
> | 8 | 10 | 10 | 3 | 13 | 13 |
>
> **Health** 24
> **Armour Class** 12
> **Speed** 40ft. (40ft. swim, 60ft. fly)
> **Proficiencies** Nature +4, Medicine +2
#### Abilities

**Hold Breath.** You can hold your breath for 10 minutes while underwater.

#### Actions

**Beak.** *Melee Attack:* +1 to hit, reach 5 ft., one target. *Hit:* 1d6 + 2 piercing damage.

**Vine Whip.** *Melee Spell Attack:* +3 to hit, reach 10ft., one target. *Hit:* 1d6 piercing damage, pull the creature up to 10ft. closer to you.

**Entangle.** *Area Spell Attack:* Grasping weeds and vines sprout from the ground in a 20-foot square. The ground in the area is now difficult terrain. A creature in the area when you cast the spell must succeed on a Strength saving throw or be [restrained](https://www.dndbeyond.com/compendium/rules/basic-rules/appendix-a-conditions#Restrained), only able to free themselves by using their action to make a Strength check (DC13).

#### Bonus Actions

**Honk.** *Special Action (3 charges / short rest):* You emit a honk at one creature within range. If the target can hear you, it must succeed on a Wisdom saving throw (DC13) or it will have disadvantage on the next ability check it makes before the end of its next turn.
31 changes: 31 additions & 0 deletions mkdocs/example/src/geese/Knife Goose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Knife Goose

![Knife Goose](knife goose.png)

> | STR | CON | DEX | INT | WIS | CHA |
> | ---- | ---- | ---- | ---- | ---- | ---- |
> | +2 | +0 | +0 | -3 | -1 | +0 |
> | 14 | 11 | 11 | 4 | -8 | 10 |
>
> **Health** 28
> **Armour Class** 12
> **Speed** 25ft. (25ft. swim, 40ft. fly)
> **Proficiencies** Intimidation +4, Athletics +2
#### Abilities

**Fearless Fowl.** You have advantage on saving throws against being frightened.

**Hold Breath.** You can hold your breath for 10 minutes while underwater.

**Savage Attacker.** *(1 / Short Rest).* When you roll damage for a melee weapon attack, you can reroll the attack's damage dice and use either total.

#### Actions

**Beak.** *Melee Attack:* +4 to hit, reach 5 ft., one target. *Hit:* 1d6 + 2 piercing damage.

**Knife.** *Melee Weapon Attack*: +4 to hit, reach 5ft., one target. *Hit:* 1d6 slashing damage.

#### Bonus Actions

**Honk.** *Special Action (3 / short rest):* You emit a honk at one creature within range. If the target can hear you, it must succeed on a Wisdom saving throw (DC 14) or it will have disadvantage on the next ability check it makes before the end of its next turn.
29 changes: 29 additions & 0 deletions mkdocs/example/src/geese/LGooseBT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# LGooseBT

![LGooseBT](LGooseBT.png)

> | STR | CON | DEX | INT | WIS | CHA |
> | ---- | ---- | ---- | ---- | ---- | ---- |
> | -1 | +0 | +1 | -4 | -1 | +2 |
> | 9 | 10 | 12 | 3 | 9 | 14 |
>
> **Health** 20
> **Armour Class** 12
> **Speed** 40ft. (40ft. swim, 60ft. fly)
> **Proficiencies** Performance +4, Persuasion +2


#### Abilities

**Hold Breath.** You can hold your breath for 10 minutes while underwater.

#### Actions

**Beak.** *Melee Attack:* +1 to hit, reach 5 ft., one target. *Hit:* 1d6 + 2 piercing damage.

#### Bonus Actions

**Honk.** *Special Action (3 / short rest):* You emit a honk at one creature within range. If the target can hear you, it must succeed on a Wisdom saving throw (DC14) or it will have disadvantage on the next ability check it makes before the end of its next turn.

**Yass.** *Support Action (2 / short rest):* Use your slay queen yass hunty vibes to give an ally [bardic inspiration](https://www.dndbeyond.com/classes/bard#BardicInspiration-75).
Binary file added mkdocs/example/src/geese/LGooseBT.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
31 changes: 31 additions & 0 deletions mkdocs/example/src/geese/Moose Goose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Moose Goose

![Moose Goose](moose goose.png)

> | STR | CON | DEX | INT | WIS | CHA |
> | ---- | ---- | ---- | ---- | ---- | ---- |
> | +1 | +2 | +0 | -4 | -1 | +0 |
> | 12 | 14 | 10 | 3 | 8 | 10 |
>
> **Health** 38
> **Armour Class** 13
> **Speed** 40ft. (40ft. swim, 60ft. fly)
> **Proficiencies** Athletics +4, Intimidation +2
#### Abilities

**Hold Breath.** You can hold your breath for 10 minutes while underwater.

#### Actions

**Beak.** *Melee Attack:* +3 to hit, reach 5 ft., one target. *Hit:* 1d6 + 2 piercing damage.

**Headbutt.** *Melee Attack:* +4 to hit, reach 5ft., one target. *Hit:* 1d8 + 2 bludgeoning damage. *Miss:* You are [stunned](https://www.dndbeyond.com/sources/basic-rules/appendix-a-conditions#Stunned) until the end of your next turn.

#### Bonus Actions

**Honk.** *Special Action (3 / short rest):* You emit a honk at one creature within range. If the target can hear you, it must succeed on a Wisdom saving throw (DC12) or it will have disadvantage on the next ability check it makes before the end of its next turn.

#### Reactions

- [ ] **Endurance.** When you take damage, you can use your reaction to roll a d12. Add your Constitution modifier to the number rolled and reduce the damage by that total.
27 changes: 27 additions & 0 deletions mkdocs/example/src/geese/Pond Goose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Pond Goose

![Pond Goose](pond goose.png)

> | STR | CON | DEX | INT | WIS | CHA |
> | ---- | ---- | ---- | ---- | ---- | ---- |
> | +0 | +0 | +2 | -4 | +0 | +0 |
> | 11 | 10 | 14 | 3 | 9 | 10 |
>
> **Health** 21
> **Armour Class** 12
> **Speed** 40ft. (40ft. swim, 60ft. fly)
> **Proficiencies** Sleight of Hand +4, Stealth +2
#### Abilities

**Hold Breath.** You can hold your breath for 10 minutes while underwater.

#### Actions

**Beak.** *Melee Attack:* +2 to hit, reach 5 ft., one target. *Hit:* 1d6 + 2 piercing damage.

**Thieving Pecks.** The target creature must succeed on a Dexterity saving throw (DC12). On a failure, the target takes 1d6 piercing damage and you successfully steal the item. On a successful save, the target takes half as much damage and you don't steal the item.

#### Bonus Actions

**Honk.** *Special Action (3 / short rest):* You emit a honk at one creature within range. If the target can hear you, it must succeed on a Wisdom saving throw (DC10) or it will have disadvantage on the next ability check it makes before the end of its next turn.
Binary file added mkdocs/example/src/geese/asparagoose.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
Binary file added mkdocs/example/src/geese/knife goose.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mkdocs/example/src/geese/moose goose.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mkdocs/example/src/geese/pond goose.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file added mkdocs/example/src/index.md
Empty file.
Empty file added mkdocs/torillic/__init__.py
Empty file.
14 changes: 14 additions & 0 deletions mkdocs/torillic/css/torillic.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
@import url("torillic/torillic.css");

body {
padding: 0;
margin: 0;
}

.torillic-background {
padding: 4rem;
}




3 changes: 3 additions & 0 deletions mkdocs/torillic/css/torillic.stub
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
This file will be replaced by the base Torillic folder when the theme is built (by running `utils/build.py`).

If you've checked out the `main` branch from GitHub, you can either build Torillic or switch to the `release` branch which is already built.
41 changes: 41 additions & 0 deletions mkdocs/torillic/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!DOCTYPE html>
<html>

<head>
<title>{% if page.title %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
<link href="{{ 'css/torillic.css'|url }}" rel="stylesheet">
{%- for path in config.extra_css %}
<link href="{{ path | url }}" rel="stylesheet">
{%- endfor %}
</head>

<body class="torillic-background">
<header class="torillic-header">
<h1>{{ config.site_name }}</h1>
<nav>
{% for nav_item in nav %}
{% if nav_item.children %}
<li>{{ nav_item.title }}
<ul>
{% for nav_item in nav_item.children %}
<li class="{% if nav_item.active %}current{% endif %}">
<a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a>
</li>
{% endfor %}
</ul>
</li>
{% else %}
<a class="{% if nav_item.active %}current{% endif %}" href="{{ nav_item.url|url }}">{{nav_item.title }}</a>
{% endif %}
{% endfor %}
</nav>
</header>
<main class="torillic-page">
{{ page.content }}
</main>
{%- for script in config.extra_javascript %}
{{ script | script_tag }}
{%- endfor %}
</body>

</html>

0 comments on commit 013f561

Please sign in to comment.