Skip to content

Commit 3708a28

Browse files
authored
add extensions to support admonitions (#71)
1 parent 81f3f05 commit 3708a28

File tree

4 files changed

+19
-8
lines changed

4 files changed

+19
-8
lines changed

docs/develop.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
You are now ready to develop your library. This guide will walk you through resolving dependencies, configuring the build, creating release artifacts, and testing your library in Processing.
44

5-
_Note: If you haven't set up your environment yet, refer to the [Getting Started guide](getting-started.md)._
5+
!!! Note
6+
If you haven't set up your environment yet, refer to the [Getting Started guide](getting-started.md).
67

78

89
## Developing the library
@@ -37,9 +38,10 @@ were to use the `commons-math3` package from `org.apache.commons` as a dependenc
3738
implementation(group = "org.apache.commons", name = "commons-math3", version = "3.6.1")
3839
```
3940

40-
NOTE: Dependencies added with `implementation` will be included in the release. Dependencies
41-
added with `compileOnly`, such as Processing core, are available for compilation, but won't
42-
be included in the release.
41+
!!! Note
42+
Dependencies added with `implementation` will be included in the release. Dependencies
43+
added with `compileOnly`, such as Processing core, are available for compilation, but won't
44+
be included in the release.
4345

4446
After you add these dependencies, **refresh Gradle**, and then you will be able to access them
4547
in your code. Refresh Gradle by going to the Gradle menu (elephant) in your IDE
@@ -89,7 +91,8 @@ those sections for [resolving dependencies](#resolving-dependencies).
8991
## Creating examples
9092
Examples help users understand your library’s functionality, it is recommended that you include several clear and well-commented samples sketches in the `examples` folder.
9193

92-
_Note: The example sketch included in this template outputs the image shown on the home page._
94+
!!! Note
95+
The example sketch included in this template outputs the image shown on the home page.
9396

9497
## Creating the release artifacts
9598
If you've already gone through the [Getting started](getting-started.md#first-steps) guide, you will have

docs/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ This documentation provides information on
1212
3. [Releasing your library](release)
1313
4. [Troubleshooting](troubleshooting.md)
1414

15+
!!! note
16+
This template is based on Gradle. If you are looking for the old Ant-based template, see processing/processing-library-template-ant
1517

1618
## References
1719
Existing references for developing libraries for Processing can be found on the following Github wiki pages:
@@ -37,4 +39,4 @@ I wish to thank the developers of these repositories, who generously provided
3739
guidance and time. This template has been developed in collaboration with
3840
[@enkatsu](https://github.com/enkatsu).
3941

40-
The example library was developed by Stig Møller Hansen ([@stixan](https://github.com/stixan)).
42+
The example library was developed by Stig Møller Hansen ([@stixan](https://github.com/stixan)).

docs/release.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ This template include a workflow that automatically deploys your documentaion we
2424

2525
Any time you want to update the documentation, edit your `.md` files and `mkdocs.yml` as needed, then push your changes to `main`. This will trigger the workflow to deploy an update.
2626

27-
_Note: You can find the workflow file at `.github/workflows/deploy_website.yml`._
27+
!!! Note
28+
You can find the workflow file at `.github/workflows/deploy_website.yml`.
2829

2930
### Alternative Hosting and Static Site Generators
3031
If you prefer not to use the built-in workflow with GitHub Pages and Material for MkDocs, you are free to use another static site generator or hosting service. Note that it’s important that the site remains online, as it serves as a reference for users of your library.
@@ -41,7 +42,8 @@ Releasing your library on GitHub allows users to access known-working versions o
4142

4243
This will trigger the GitHub workflow (`.github/workflows/release.yml`), which automatically create release artifacts—`*.txt`, `*.zip`, `*.pdex` files—and add them to the release.
4344

44-
_Note: By default, GitHub will also include compressed versions of your source code (e.g., `Source code (zip)` and `Source code (tar.gz)`)._
45+
!!! Note
46+
By default, GitHub will also include compressed versions of your source code (e.g., `Source code (zip)` and `Source code (tar.gz)`).
4547

4648
For more details on releases, see GitHub’s [official guide on releasing projects](https://docs.github.com/en/repositories/releasing-projects-on-github).
4749

mkdocs.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ theme:
1414
- navigation.top
1515
- navigation.footer
1616

17+
markdown_extensions:
18+
- admonition
19+
- pymdownx.details
20+
- pymdownx.superfences
1721

1822
copyright: MIT Licence.
1923

0 commit comments

Comments
 (0)