Repository: haren724/wallpaper-player-mac
Branch: main
Commit: 889b9d669426
Files: 12
Total size: 4.7 KB

Directory structure:
gitextract_e8vfjft_/

├── .github/
│   └── workflows/
│       └── docs.yml
├── .gitignore
├── Package.swift
├── README.md
└── Sources/
    ├── User_Documentation_en_US/
    │   ├── Documentation.docc/
    │   │   ├── articles/
    │   │   │   ├── import-your-first-wallpaper.md
    │   │   │   └── supported-wallpaper-types.md
    │   │   └── homepage.md
    │   └── UserDocumentation.swift
    └── User_Documentation_zh_CN/
        ├── Documentation.docc/
        │   ├── articles/
        │   │   ├── import-your-first-wallpaper.md
        │   │   └── supported-wallpaper-types.md
        │   └── homepage.md
        └── UserDocumentation.swift

================================================
FILE CONTENTS
================================================

================================================
FILE: .github/workflows/docs.yml
================================================
name: Documentation

on:
  push:
    branches:
    - main
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow one concurrent deployment
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  docs:
    runs-on: ubuntu-22.04

    steps:
    - uses: actions/checkout@v4.2.2
    - name: Set up Pages
      uses: actions/configure-pages@v5.0.0
    - name: Set up Swift
      uses: swift-actions/setup-swift@v2.2.0
      with:
        swift-version: '6.0.0'
    - name: Generate Docs (en_US)
      run: |
        mkdir -p ./docs/en_us
        swift package --allow-writing-to-directory ./docs/en_us \
        generate-documentation --target "User_Documentation_en_US" \
        --disable-indexing \
        --transform-for-static-hosting \
        --hosting-base-path "wallpaper-player-mac/en_us" \
        --output-path ./docs/en_us
    - name: Generate Docs (zh_CN)
      run: |
        mkdir -p ./docs/zh_cn
        swift package --allow-writing-to-directory ./docs/zh_cn \
        generate-documentation --target "User_Documentation_zh_CN" \
        --disable-indexing \
        --transform-for-static-hosting \
        --hosting-base-path "wallpaper-player-mac/zh_cn" \
        --output-path ./docs/zh_cn
    - name: Upload artifact
      uses: actions/upload-pages-artifact@v3.0.1
      with:
        path: ./docs

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: docs

    steps:
    - name: Deploy Docs
      uses: actions/deploy-pages@v4.0.5


================================================
FILE: .gitignore
================================================
.build
.index-build
DerivedData
/.previous-build
xcuserdata
.DS_Store
*~
\#*
.\#*
.*.sw[nop]
*.xcscmblueprint
/default.profraw
*.xcodeproj
Utilities/Docker/*.tar.gz
.swiftpm
Package.resolved
/build
*.pyc
.docc-build
.vscode
Utilities/InstalledSwiftPMConfiguration/config.json
.devcontainer
xcschememanagement.plist
*.xcscheme


================================================
FILE: Package.swift
================================================
// swift-tools-version: 6.0
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    name: "Wallpaper_Player_Documentation",
    products: [
        .library(
            name: "Wallpaper_Player_Documentation",
            targets: ["User_Documentation_en_US", "User_Documentation_zh_CN"])],
    dependencies: [
        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0")],
    targets: [
        .target(name: "User_Documentation_en_US"),
        .target(name: "User_Documentation_zh_CN")]
)


================================================
FILE: README.md
================================================
# Wallpaper Player

An open source wallpaper engine for mac (which is not relative to the existing one on Steam)

<p align="center">
<a href="https://testflight.apple.com/join/k781W6GF">Testflight</a>
</p>

Hi there!
I hosted a chat group on QQ: `228230228`  
Guys If you are interested in contributing to this project, please 
join this chat so that we could communicate much easier.

大家好呀！ 
我在QQ上建了个群：`228230228` 
如果您有兴趣为这个项目做出贡献，不介意的话加一下呗，以便我们可以更方便地沟通。


================================================
FILE: Sources/User_Documentation_en_US/Documentation.docc/articles/import-your-first-wallpaper.md
================================================
# Import your first Wallpaper

Teach you how to add and display your first wallpaper using this App

## Overview

To learn more about wallpaper types, see <doc:supported-wallpaper-types>

### Section header

<!--@START_MENU_TOKEN@-->Text<!--@END_MENU_TOKEN@-->


================================================
FILE: Sources/User_Documentation_en_US/Documentation.docc/articles/supported-wallpaper-types.md
================================================
#  Supported Wallpaper Types




================================================
FILE: Sources/User_Documentation_en_US/Documentation.docc/homepage.md
================================================
# ``User_Documentation_en_US``

@Metadata {
    @DisplayName("Wallpaper Player (English)")
    @DocumentationExtension(mergeBehavior: override)
    @PageImage(
               purpose: icon,
               source: "WallpaperPlayer-icon", 
               alt: "A technology icon representing the Wallpaper_Player framework.")
    @PageColor(blue)
}

An open source wallpaper engine for Mac.

## Overview

Wallpaper Player is your ideal, brilliant and dynamic desktop picture manager. 
It supports multiple media types to be added to your desktop.

## Topics

### Essentials

- <doc:import-your-first-wallpaper>


================================================
FILE: Sources/User_Documentation_en_US/UserDocumentation.swift
================================================
//
//  File.swift
//  Wallpaper Player Documentation
//
//  Created by Haren on 2025/1/16.
//

import Foundation

class User_Documentation {
    
}


================================================
FILE: Sources/User_Documentation_zh_CN/Documentation.docc/articles/import-your-first-wallpaper.md
================================================
# 导入你的第一张壁纸

引导你使用本app导入并使用你的第一张壁纸

## 总览

如果想了解软件支持的所有壁纸类型，请查阅 <doc:supported-wallpaper-types>

### 子标题


================================================
FILE: Sources/User_Documentation_zh_CN/Documentation.docc/articles/supported-wallpaper-types.md
================================================
# 支持的壁纸类型




================================================
FILE: Sources/User_Documentation_zh_CN/Documentation.docc/homepage.md
================================================
# ``User_Documentation_zh_CN``

@Metadata {
    @DisplayName("Wallpaper Player (Chinese Simplified)")
    @DocumentationExtension(mergeBehavior: override)
    @PageImage(
               purpose: icon,
               source: "WallpaperPlayer-icon", 
               alt: "A technology icon representing the Wallpaper_Player framework.")
    @PageColor(blue)
}

Mac平台的开源壁纸引擎

## 总览

Wallpaper Player是macOS下完成度最高的壁纸软件之一，并支持多种媒体格式。

## 话题

### 基础

- <doc:import-your-first-wallpaper>


================================================
FILE: Sources/User_Documentation_zh_CN/UserDocumentation.swift
================================================
//
//  File.swift
//  Wallpaper Player Documentation
//
//  Created by Haren on 2025/1/16.
//

import Foundation

class User_Documentation {
    
}