Create docs
All checks were successful
Gitea Actions Demo / publish (push) Successful in 21s

This commit is contained in:
david-swift 2025-04-12 23:17:26 +02:00
parent 1fad85021d
commit f6d1110d6b
25 changed files with 41 additions and 38 deletions

View File

@ -47,7 +47,7 @@ show_source = true
[extra.nav]
links = [
{ url = "@/backends/_index.md", name = "Backends" },
{ url = "/patterns", name = "Patterns" },
{ url = "@/docs/GettingStarted/index.md", name = "Docs" },
{ url = "https://forums.aparoksha.dev/", name = "Community" },
{ url = "https://git.aparoksha.dev/aparoksha", name = "Code" },
]

View File

@ -19,6 +19,7 @@ Aparoksha is easy-to-use, safe, and <i>aparoksha</i>, meaning that its reactive
{% alert(warning=true) %}
This project is currently under development and not yet ready for production.
Follow the project [on the Fediverse](https://mastodon.de/@aparoksha) to stay up to date.
The most mature part is [Adwaita for Swift](/backends/adwaita/).
{% end %}
<br>
@ -29,7 +30,7 @@ Follow the project [on the Fediverse](https://mastodon.de/@aparoksha) to stay up
A view is a piece of the user interface.
Create your own views, such as `Avatar`, `Post`, and `Timeline`.
Combine them into pages, windows, and apps.
Combine them to create more complex views, windows, and apps.
<!---
<aside>
@ -55,7 +56,7 @@ struct Timeline: View {
## The Magic of the State
Each of your views has the ability to store state throughout view updates.
Let's create a simple counter view:
Take a look at a simple, fully functional counter view:
<!---
<aside>

View File

Before

Width:  |  Height:  |  Size: 826 B

After

Width:  |  Height:  |  Size: 826 B

View File

Before

Width:  |  Height:  |  Size: 1.0 KiB

After

Width:  |  Height:  |  Size: 1.0 KiB

View File

@ -1,9 +1,8 @@
+++
title = "Button"
description = "Let the user trigger an event."
date = 2024-11-15
[taxonomies]
tags = ["Aparoksha", "Windows", "Linux", "macOS"]
weight = 1
[extra]
section = 1
+++
The button is one of the most common user interface elements.

View File

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 1.5 KiB

View File

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 1.3 KiB

View File

Before

Width:  |  Height:  |  Size: 1.1 KiB

After

Width:  |  Height:  |  Size: 1.1 KiB

View File

Before

Width:  |  Height:  |  Size: 994 B

After

Width:  |  Height:  |  Size: 994 B

View File

@ -1,8 +1,8 @@
+++
title = "Documentation"
description = "A collection of links to the documentation of the components of Aparoksha."
[taxonomies]
tags = ["Linux", "macOS", "Windows", "Aparoksha"]
title = "Detailed Docs"
weight = 0
[extra]
section = 2
+++
The following links lead to the API documentation of individual parts of the Aparoksha framework.

View File

@ -1,9 +1,8 @@
+++
title = "Flat Navigation"
description = "A navigation pattern for views of equal importance."
date = 2024-11-16
[taxonomies]
tags = ["Aparoksha", "Windows", "Linux", "macOS"]
weight = 0
[extra]
section = 1
+++
In a flat navigation structure, each page is equivalent in importance and can be opened form any of the others.

View File

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

View File

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

View File

Before

Width:  |  Height:  |  Size: 169 KiB

After

Width:  |  Height:  |  Size: 169 KiB

View File

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB

View File

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -0,0 +1,15 @@
+++
title = "Getting Started"
weight = 0
[extra]
section = 0
+++
Aparoksha is currently under development. The availability of views is limited.
Therefore, the usage of Aparoksha is not currently recommended.
However, certain parts of the project are already quite stable.
This includes [Adwaita for Swift](/backends/adwaita/) for the creation of [GNOME](https://www.gnome.org/) apps
and the [Meta package](https://meta.aparoksha.dev/documentation/meta/) that can be used to create your own UI frameworks.
Note that those docs are incomplete.

11
content/docs/_index.md Normal file
View File

@ -0,0 +1,11 @@
+++
title = "Docs"
sort_by = "weight"
template = "subproject_list.html"
page_template = "documentation_page.html"
[extra]
sections = [
"Patterns",
"More"
]
+++

View File

@ -1,9 +0,0 @@
+++
title = "Views and Patterns"
sort_by = "date"
template = "subproject_list.html"
page_template = "subproject.html"
+++
The following views and patterns are available in the Aparoksha framework.
Other patterns available in a platform-specific framework can be used in your app, but are not listed here if there is no cross-platform version at the moment.

View File

@ -1,7 +0,0 @@
+++
title = "Getting Started"
description = "Learn Aparoksha following a simple path."
date = 2023-09-12
[taxonomies]
tags = ["Linux", "macOS", "Windows", "Aparoksha"]
+++

View File

@ -1,6 +0,0 @@
+++
title = "Tutorials"
sort_by = "date"
template = "article_list.html"
page_template = "article.html"
+++

@ -1 +1 @@
Subproject commit 9f538c804d83b59cd4cb0ca9bd17f3165b37c01d
Subproject commit 4e6f1af8064ee89612803ad5d5cc397f25b6a82b