Skip to content

Commit

Permalink
Docs: Add community page(s) (#3941)
Browse files Browse the repository at this point in the history
* docs: fix tip

* update packages

* add showase

* add 3 showcases from v2

* mdx -> md

* add links page

* add templates page with a caution

* add a tip

* move desc up

* use X instead of twitter

* fix link

* Add clave

* add how to section
  • Loading branch information
stavros-k authored Dec 9, 2024
1 parent dcb7a7f commit 6be3295
Show file tree
Hide file tree
Showing 72 changed files with 1,188 additions and 761 deletions.
1 change: 1 addition & 0 deletions docs/.npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
save-exact=true
17 changes: 17 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ export default defineConfig({
sitemap(),
starlight({
title: "",
// If a title is added, also update the delimiter.
titleDelimiter: "",
logo: {
dark: "./src/assets/wails-logo-horizontal-dark.svg",
light: "./src/assets/wails-logo-horizontal-light.svg",
Expand Down Expand Up @@ -100,6 +102,21 @@ export default defineConfig({
collapsed: true,
autogenerate: { directory: "api", collapsed: true },
},
{
label: "Community",
collapsed: true,
items: [
{ label: "Links", link: "/community/links" },
{ label: "Templates", link: "/community/templates" },
{
label: "Showcase",
autogenerate: {
directory: "community/showcase",
collapsed: true,
},
},
],
},
{
label: "Development",
collapsed: true,
Expand Down
1,150 changes: 398 additions & 752 deletions docs/package-lock.json

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@
"astro": "astro"
},
"dependencies": {
"@astrojs/check": "^0.9.4",
"@astrojs/starlight": "^0.29.2",
"astro": "^4.16.10",
"sharp": "^0.32.5",
"@astrojs/check": "0.9.4",
"@astrojs/starlight": "0.29.2",
"astro": "4.16.17",
"sharp": "0.33.5",
"starlight-blog": "0.15.0",
"starlight-image-zoom": "0.9.0",
"starlight-links-validator": "0.13.2",
"typescript": "^5.7.2"
"starlight-links-validator": "0.13.4",
"starlight-showcases": "0.2.0",
"typescript": "5.7.2"
}
}
Binary file added docs/src/assets/showcase-images/bboard.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/cfntracker.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/clave.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/emailit.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/encrypteasy.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/esp-studio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/filehound.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/hiposter.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/mac-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/mchat.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added docs/src/assets/showcase-images/mollywallet.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/october.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/optimus.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/portfall.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/resizem.webp
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file added docs/src/assets/showcase-images/scriptbar.webp
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/surge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/tiny-rdm1.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/tiny-rdm2.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/varly2.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/wailsterm.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/wally.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/warmine1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/warmine2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/showcase-images/wombat.webp
Binary file not shown.
Binary file added docs/src/assets/showcase-images/ytd.webp
Binary file not shown.
32 changes: 32 additions & 0 deletions docs/src/content/docs/community/links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: Links
---

This page serves as a list for community related links.

:::tip[How to Submit a Link]

You can click the `Edit this page` at the bottom of this page to submit a PR.

:::

## Awesome Wails

The [definitive list](https://github.com/wailsapp/awesome-wails) of links
related to Wails.

## Support Channels

- [Wails Discord Server](https://discord.gg/JDdSxwjhGf)
- [Github Issues](https://github.com/wailsapp/wails/issues)
- [v2 Beta Discussion Board](https://github.com/wailsapp/wails/discussions/828)

## Social Media

- [Twitter](https://x.com/wailsapp)
- [Wails Chinese Community QQ Group](https://qm.qq.com/cgi-bin/qm/qr?k=PmIURne5hFGNd7QWzW5qd6FV-INEjNJv&jump_from=webapi) -
Group number: 1067173054

## Other Tutorials and Articles

- [Building of Bulletin Board](https://blog.customct.com/building-bulletin-board)
13 changes: 13 additions & 0 deletions docs/src/content/docs/community/showcase/_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: My Project
---

<!-- This is an image -->

![My Project](../../../../assets/showcase-images/my-project.webp)

<!-- Add some content here -->

<!-- This is a link -->

[My Project](https://my-project.com)
16 changes: 16 additions & 0 deletions docs/src/content/docs/community/showcase/bulletinboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: BulletinBoard
---

![BulletinBoard](../../../../assets/showcase-images/bboard.webp)

The [BulletinBoard](https://github.com/raguay/BulletinBoard) application is a
versital message board for static messages or dialogs to get information from
the user for a script. It has a TUI for creating new dialogs that can latter be
used to get information from the user. It's design is to stay running on your
system and show the information as needed and then hide away. I have a process
for watching a file on my system and sending the contents to BulletinBoard when
changed. It works great with my workflows. T here is also an
[Alfred workflow](https://github.com/raguay/MyAlfred/blob/master/Alfred%205/EmailIt.alfredworkflow)
for sending information to the program. The workflow is also for working with
[EmailIt](https://github.com/raguay/EmailIt).
36 changes: 36 additions & 0 deletions docs/src/content/docs/community/showcase/cfntracker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: CFN Tracker
---

![CFN Tracker](../../../../assets/showcase-images/cfntracker.webp)

[CFN Tracker](https://github.com/williamsjokvist/cfn-tracker) - Track any Street
Fighter 6 or V CFN profile's live matches. Check
[the website](https://cfn.williamsjokvist.se/) to get started.

## Features

- Real-time match tracking
- Storing match logs and statistics
- Support for displaying live stats to OBS via Browser Source
- Support for both SF6 and SFV
- Ability for users to create their own OBS Browser themes with CSS

### Major tech used alongside Wails

- [Task](https://github.com/go-task/task) - wrapping the Wails CLI to make
common commands easy to use
- [React](https://github.com/facebook/react) - chosen for its rich ecosystem
(radix, framer-motion)
- [Bun](https://github.com/oven-sh/bun) - used for its fast dependency
resolution and build-time
- [Rod](https://github.com/go-rod/rod) - headless browser automation for
authentication and polling changes
- [SQLite](https://github.com/mattn/go-sqlite3) - used for storing matches,
sessions and profiles
- [Server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events) -
a http stream to send tracking updates to OBS browser sources
- [i18next](https://github.com/i18next/) - with backend connector to serve
localization objects from the Go layer
- [xstate](https://github.com/statelyai/xstate) - state machines for auth
process and tracking
18 changes: 18 additions & 0 deletions docs/src/content/docs/community/showcase/clave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Clave
---

![Clave](../../../../assets/showcase-images/clave.gif)

Key Features

- 🎨 Simple, intuitive design for hassle-free experience
- ✅ Add accounts easily via manual entry or QR code image import.
- 🔒 End-to-end encryption with PIN or Touch ID(macOS only).
- 💻 Available for macOS, Windows, and Linux
- ⚡ Quick access from system tray for convenience
- 📂 Easily backup and restore your profiles

Try Clave Today!

💻 [https://clave.rocks](https://clave.rocks)
14 changes: 14 additions & 0 deletions docs/src/content/docs/community/showcase/emailit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: EmailIt
---

![EmailIt](../../../../assets/showcase-images/emailit.webp)

[EmailIt](https://github.com/raguay/EmailIt/) is a Wails 2 program that is a
markdown based email sender only with nine notepads, scripts to manipulate the
text, and templates. It also has a scripts terminal to run scripts in EmailIt on
files in your system. The scripts and templates can be used from the commandline
itself or with the Alfred, Keyboard Maestro, Dropzone, or PopClip extensions. It
also supports scripts and themes downloaded form GitHub. Documentation is not
complete, but the programs works. It’s built using Wails2 and Svelte, and the
download is a universal macOS application.
16 changes: 16 additions & 0 deletions docs/src/content/docs/community/showcase/encrypteasy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: EncryptEasy
---

![EncryptEasy](../../../../assets/showcase-images/encrypteasy.webp)

**[EncryptEasy](https://www.encrypteasy.app) is a simple and easy to use PGP
encryption tool, managing all your and your contacts keys. Encryption should be
simple. Developed with Wails.**

Encrypting messages using PGP is the industry standard. Everyone has a private
and a public key. Your private key, well, needs to be kept private so only you
can read messages. Your public key is distributed to anyone who wants to send
you secret, encrypted messages. Managing keys, encrypting messages and
decrypting messages should be a smooth experience. EncryptEasy is all about
making it easy.
9 changes: 9 additions & 0 deletions docs/src/content/docs/community/showcase/espstudio.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: ESP Studio
---

![ESP Studio](../../../../assets/showcase-images/esp-studio.png)

[ESP Studio](https://github.com/torabian/esp-studio) - Cross platform, Desktop,
Cloud, and Embedded software for controlling ESP/Arduino devices, and building
complex IOT workflows and control systems
29 changes: 29 additions & 0 deletions docs/src/content/docs/community/showcase/filehound.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: FileHound Export Utility
---

![FileHound Export Utility](../../../../assets/showcase-images/filehound.webp)

[FileHound Export Utility](https://www.filehound.co.uk/) FileHound is a cloud
document management platform made for secure file retention, business process
automation and SmartCapture capabilities.

The FileHound Export Utility allows FileHound Administrators the ability to run
a secure document and data extraction tasks for alternative back-up and recovery
purposes. This application will download all documents and/or meta data saved in
FileHound based on the filters you choose. The metadata will be exported in both
JSON and XML formats.

Backend built with:

- Go 1.15
- Wails 1.11.0
- go-sqlite3 1.14.6
- go-linq 3.2

Frontend with:

- Vue 2.6.11
- Vuex 3.4.0
- TypeScript
- Tailwind 1.9.6
8 changes: 8 additions & 0 deletions docs/src/content/docs/community/showcase/hiposter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: hiposter
---

![hiposter](../../../../assets/showcase-images/hiposter.webp)

[hiposter](https://github.com/obity/hiposter) is a simple and efficient http API
testing client tool. Based on Wails, Go and sveltejs.
Loading

0 comments on commit 6be3295

Please sign in to comment.