Added info shortcode and documented it

mypaint · Mar 13, 2024 · 5cc0f11 · 5cc0f11
1 parent 249010a
commit 5cc0f11
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 4 deletions.
diff --git a/assets/icons/alert-outline.svg b/assets/icons/alert-outline.svg
diff --git a/pages/docs/backend/_index.md b/pages/docs/backend/_index.md
@@ -8,6 +8,8 @@ including files and technical concepts to help developers conceptualise MyPaint.
 The most detailed documentation for the project will always be contained within
 the source code.<!--more-->
 
+{{< info type="warning" >}}This section is heavily in development{{< /info >}}
+
 # Contributor Responsibilities
 - Please write code that matches what you see elsewhere. [Style guide]({{< ref "../contributing/style-guide" >}})
 - [Git workflow]({{< ref "../contributing/git" >}})

diff --git a/pages/docs/contributing/_index.md b/pages/docs/contributing/_index.md
@@ -10,6 +10,8 @@ the MyPaint project.<!--more-->
 We abide by an agreed [code of conduct]({{< relref "code-of-conduct" >}}).
 Please follow them when engaging with the project, it helps us focus on what's important.
 
+{{< info >}}This section may contain incomplete pages{{< /info >}}
+
 # Getting Started
 {{< flex grow="true" >}}
 {{< button content="Translating MyPaint" href="translating/adding-translations"

diff --git a/pages/docs/contributing/documentation.md b/pages/docs/contributing/documentation.md
@@ -188,6 +188,7 @@ Front matter specific to [list pages][hugo-list]
 |``grid``|Inline|[``rows``][css-rows], [``columns``][css-columns], [``align``][css-align]|Enclose the contained content in a [grid][css-grid]|
 |``id``|Content|``0``: string|Enclose the contained content in a [``span``][html-span] tag with [``id="0"``][html-attr-id]|
 |``img``|Inline|[``alt``][html-img-alt]: string, [``src``][html-img-src]: path, ``caption``: string, [``float``][css-float], [``width``][css-max-width] |Insert an [image][html-img]|
+|``info``|Content|``type``: oneof (information, warning)|Draw an infobox|
 |``md``|Content|None|Renders markdown in contained content (for [shortcodes without markdown][hugo-shortcode-nomd])|
 |``paramref``|Inline|``0``: [Site parameter][hugo-params]|Like [``ref``][hugo-ref], but with a site parameter|
 

diff --git a/pages/docs/hig/_index.md b/pages/docs/hig/_index.md
@@ -5,13 +5,13 @@ title = "Human Interface Guidelines"
 Developing a feature that gets exposed to the user? Refer to these guidelines to
 implement them in a consistent fashion.<!--more-->
 
-{{< colour "yellow" >}}**This section is heavily in development**{{< /colour >}}
-
 MyPaint's [human interface guidelines](https://en.wikipedia.org/wiki/Human_interface_guidelines)
 sets out rules to help developers maintain consistency in the [user experience]({{< relref "../uxui" >}}).
 Additionally, by providing these guidelines, developers have a point of reference
 when justifying inconsistent design.
 
+{{< info type="warning" >}}This section is heavily in development{{< /info >}}
+
 # Throwaway
 - Excellent fullscreen workflow. GUI elements can appear only on demand and directly
 at the cursor.

diff --git a/pages/docs/uxui/_index.md b/pages/docs/uxui/_index.md
@@ -7,7 +7,7 @@ between specifications and the backend. It is the primary source of reference fo
 developers and designers when suggesting, discussing, and prototyping new user-facing
 features for MyPaint.<!--more-->
 
-{{< colour "yellow" >}}**This section is heavily in development**{{< /colour >}}
+{{< info type="warning" >}}This section is heavily in development{{< /info >}}
 
 # UX/UI Philosophy
 As MyPaint continues to grow and expand its feature set, the project needs to ensure

diff --git a/themes/mypaint b/themes/mypaint