Skip to content

Commit 5fe52c1

Browse files
committed
Maybe a working web version is up?
1 parent a9a2a34 commit 5fe52c1

File tree

7 files changed

+112
-188
lines changed

7 files changed

+112
-188
lines changed

.github/workflows/deploy.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Build and Deploy Documentation
2+
on:
3+
push:
4+
branches:
5+
- main # Set your default branch here if it's not main
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
- name: Set up Python
13+
uses: actions/setup-python@v4
14+
with:
15+
python-version: 3.9
16+
17+
- name: Install dependencies
18+
run: |
19+
python -m pip install --upgrade pip
20+
pip install mkdocs-material
21+
22+
- name: Build site
23+
run: mkdocs build
24+
25+
- name: Deploy to GitHub Pages
26+
uses: peaceiris/actions-gh-pages@v3
27+
with:
28+
github_token: ${{ secrets.GITHUB_TOKEN }}
29+
publish_dir: ./site

docs/examples/gallery.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

docs/features/animation.md

Lines changed: 0 additions & 50 deletions
This file was deleted.

docs/index.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# PyGameUI
2+
3+
Python library that makes making pygame-based-UIs easy!
4+
5+
## Short overview
6+
7+
`PygameUI` is a small Python library written in Python that makes it easier to create UI elements like buttons, texts, inputs, and more when using the Python library PyGame. The library also supplies the user with many optional features for customizing the UI elements.
8+
9+
## Documentation
10+
11+
Documentation in web form is available at [https://trymbf.github.io/pygameui/](https://trymbf.github.io/pygameui/)
12+
13+
## Installation
14+
15+
Start by downloading the PyGameUI python file from the [releases page](https://github.com/trymbf/pygameui/releases).
16+
17+
Then place the PyGameUI file in the same folder as your project files.
18+
19+
![gif of putting the file in the same folder](https://trymbf.github.io/pygameui/assets//gifs//add_pygameui.gif)
20+
21+
## Available Elements
22+
23+
- **Element**
24+
The base class for all UI elements. It provides basic functionality such as setting position, drawing, and updating. [Learn more!](components/element.md)
25+
- **Text**
26+
A class for displaying text. It extends the `Element` class and adds text-specific attributes and methods. [Learn more!](components/text.md)
27+
- **Image**
28+
A class for displaying images. It extends the `Element` class and adds image-specific attributes and methods. [Learn more!](components/image.md)
29+
- **Input**
30+
A class for creating input fields. It extends the `Text` class and adds input-specific attributes and methods. [Learn more!](components/input.md)
31+
- **Button**
32+
A class for creating buttons. It extends the `Element` class and adds button-specific attributes and methods. [Learn more!](components/button.md)
33+
34+
## Getting Help
35+
36+
- [GitHub Issues](https://github.com/trymbf/pygameui/issues)
37+
38+
## Current Version
39+
40+
The current version of PygameUI is **2.1.0**.
41+
42+
## License
43+
44+
PygameUI is open-source software.

docs/tutorials/basic.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

mkdocs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
site_name: PygameUI
2+
site_description: Documentation for PygameUI library
3+
site_author: Trym Bringsrud Fekjær
4+
repo_url: https://github.com/trymbf/PygameUI
5+
6+
theme:
7+
name: material
8+
palette:
9+
primary: indigo
10+
accent: indigo
11+
features:
12+
- navigation.instant
13+
- navigation.tracking
14+
- navigation.expand
15+
- navigation.indexes
16+
- content.code.copy
17+
18+
markdown_extensions:
19+
- pymdownx.highlight:
20+
anchor_linenums: true
21+
- pymdownx.superfences
22+
- pymdownx.inlinehilite
23+
- pymdownx.tabbed
24+
- pymdownx.critic
25+
- admonition
26+
- codehilite
27+
- footnotes
28+
- toc:
29+
permalink: true
30+
31+
nav:
32+
- Home: index.md
33+
- Getting Started: getting-started.md
34+
- Components:
35+
- Element: components/element.md
36+
- Text: components/text.md
37+
- Button: components/button.md
38+
- Image: components/image.md
39+
- Input: components/input.md

test2.py

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)