Skip to content

Commit c322dad

Browse files
committed
Add headings to steps
1 parent eae32ae commit c322dad

File tree

1 file changed

+20
-11
lines changed
  • src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples

1 file changed

+20
-11
lines changed

src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/01-overview.mdx

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,18 @@ Splashkit website.
2626

2727
<Steps>
2828

29-
1. **Choose a Planner Card or Idea**:
30-
Pick an existing planner card that matches a SplashKit function, or create a unique example. Make
31-
sure the idea clearly demonstrates the function in a practical or visually interesting way.
29+
1. ### Choose a Planner Card or Idea
30+
31+
Pick an existing planner card that matches a SplashKit function, or create a unique example.
32+
33+
Make sure the idea clearly demonstrates the function in a practical or visually interesting way.
34+
35+
2. ### Develop a Demonstrative Program
3236

33-
2. **Develop a Demonstrative Program**:
3437
Write a simple program to illustrate the function’s use. Focus on clarity and simplicity,
3538
ensuring that the code is easy to follow and that it showcases the function effectively.
3639

37-
3. **Write the Program in Multiple Languages**:
40+
3. ### Write the Program in Multiple Languages
3841

3942
- **C++**: Implement the example with standard C++ practices, providing a version using SplashKit
4043
and one without SplashKit (Beyond SplashKit).
@@ -46,35 +49,41 @@ Splashkit website.
4649
- **C#**: Provide both a version using top-level statements and an Object-Oriented (OOP) version.
4750
- **Python**: Write a Python version that is straightforward and reflects the same functionality.
4851

49-
4. **Create a Title for the example**:
52+
4. ### Create a Title for the example
5053

5154
- Think of a title that describes the overall functionality of the program.
5255
- Be creative with this title. It should not be the name of the function, or use the word
5356
"Example".
5457

55-
5. **Capture Output of Program**: Run the program in any of the languages to capture the details of
56-
the program running. You might do this with a screenshot, screen recording converted to a GIF, or
57-
an audio recording.
58+
5. ### Capture Output of Program
59+
60+
Run the program in any of the languages to capture the details of the program running.
61+
62+
You might do this with a screenshot, screen recording converted to a GIF, or an audio recording.
5863

5964
| Output Format | Accepted File Type | Example of when to use |
6065
| ---------------- | ------------------ | --------------------------------------------------------- |
6166
| Screenshots | `.png` file | Simple program without any user inputs or animations. |
6267
| Screen Recording | `.gif` file | The program has user inputs or animations to demonstrate. |
6368
| Audio Recording | `.webm` file | The program include audio sounds. |
6469

65-
6. **Add Files to the Correct Folder in the SplashKit Repository**:
70+
6. ### Add Files to the Correct Folder in the SplashKit Repository
6671

6772
- Copy your files into the appropriate folder within the `splashkit.io-starlight` repository.
6873
- Ensure file names and directory paths are consistent with SplashKit’s structure.
6974

70-
7. **Submit a Pull Request for Usage Examples**:
75+
7. ### Submit a Pull Request for Usage Examples
76+
7177
Follow the steps in the
7278
[Pull Requests for Usage Examples guide](/products/splashkit/splashkit-website/usage-examples/03-usage-pull-request).
79+
7380
Use the provided PR template, describe your example clearly, and attach explanations and
7481
screenshots to the pull request.
7582

7683
</Steps>
7784

85+
## Links to other pages
86+
7887
<LinkCard
7988
title="Creating Usage Examples"
8089
description="How to create usage examples for the Splashkit website, including the necessary

0 commit comments

Comments
 (0)