Skip to content

Commit a2bec8f

Browse files
parhelia512parhelia512
committed
doc template
1 parent c737b03 commit a2bec8f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+6453
-1
lines changed

‎.github/workflows/main.yml‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# On every push this script is executed
2+
on: push
3+
name: Build and deploy GH Pages
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
if: github.ref == 'refs/heads/main'
8+
steps:
9+
- name: checkout
10+
uses: actions/checkout@v4
11+
- name: build_and_deploy
12+
uses: DeadPoetSpoon/[email protected]
13+
env:
14+
# Target branch
15+
PAGES_BRANCH: gh-pages
16+
# Provide personal access token
17+
# TOKEN: ${{ secrets.TOKEN }}
18+
# Or if publishing to the same repo, use the automatic token
19+
TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Public
2+
public
3+
4+
# DS_Store
5+
.DS_Store
6+
._.DS_Store
7+
**/.DS_Store
8+
**/._.DS_Store
9+
10+
# Binary
11+
src/tailwindcss

‎README.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
# throneproj.github.io
1+
# throneproj.github.io
2+
This document is still under revision. Your pull requests are welcome.

‎config.toml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# The URL the site will be built for
2+
base_url = "https://throneproj.github.io"
3+
title = "Throne"
4+
description = "Throne"
5+
6+
build_search_index = true
7+
default_language = "en"
8+
generate_feeds = true
9+
generate_sitemap = true
10+
11+
[markdown]
12+
highlight_code = true
13+
bottom_footnotes = true
14+
highlight_theme = "ayu-mirage"
15+
16+
[languages.fa]
17+
generate_feeds = true
18+
19+
[languages.ru]
20+
generate_feeds = true
21+
build_search_index = true
22+
23+
[languages.zh]
24+
generate_feeds = true
25+
build_search_index = true
26+
27+
[extra]
28+
logo_text = "Throne"
29+
logo_image_path = "images/Throne.png"
30+
default_thumbnail = "images/default_thumbnail.jpg"
31+
default_colorset = "dark"
32+
gtag = ""
33+
sidebar_expand_depth = 1
34+
disable_root_sidebar_hide = false
35+
36+
nav = [
37+
{ name = "Documents", url = "/introduction", type = "url", icon = "fa-solid fa-book" },
38+
{ name = "GitHub", url = "https://github.com/throneproj/Throne", type = "url", icon = "fa-brands fa-github" },
39+
]

‎content/_index.fa.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
template = "landing.html"
3+
title = "Throne"
4+
5+
[extra]
6+
version = "v1.0.0"
7+
8+
[extra.hero]
9+
title = "Throne"
10+
description = "Cross-platform GUI proxy utility (Empowered by sing-box)"
11+
cta_buttons = [
12+
{ text = "Get Started", url = "/introduction", style = "primary" },
13+
{ text = "View on GitHub", url = "https://github.com/throneproj/Throne", style = "secondary" },
14+
]
15+
+++

‎content/_index.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
template = "landing.html"
3+
title = "Throne"
4+
5+
[extra]
6+
version = "v1.0.0"
7+
8+
[extra.hero]
9+
title = "Throne"
10+
description = "Cross-platform GUI proxy utility (Empowered by sing-box)"
11+
cta_buttons = [
12+
{ text = "Get Started", url = "/introduction", style = "primary" },
13+
{ text = "View on GitHub", url = "https://github.com/throneproj/Throne", style = "secondary" },
14+
]
15+
+++

‎content/_index.ru.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
template = "landing.html"
3+
title = "Throne"
4+
5+
[extra]
6+
version = "v1.0.0"
7+
8+
[extra.hero]
9+
title = "Throne"
10+
description = "Cross-platform GUI proxy utility (Empowered by sing-box)"
11+
cta_buttons = [
12+
{ text = "Get Started", url = "/introduction", style = "primary" },
13+
{ text = "View on GitHub", url = "https://github.com/throneproj/Throne", style = "secondary" },
14+
]
15+
+++

‎content/_index.zh.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
template = "landing.html"
3+
title = "Throne"
4+
5+
[extra]
6+
version = "v1.0.0"
7+
8+
[extra.hero]
9+
title = "Throne"
10+
description = "Cross-platform GUI proxy utility (Empowered by sing-box)"
11+
cta_buttons = [
12+
{ text = "Get Started", url = "/introduction", style = "primary" },
13+
{ text = "View on GitHub", url = "https://github.com/throneproj/Throne", style = "secondary" },
14+
]
15+
+++

‎content/get_started/_index.fa.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
+++
2+
title = "Get Started"
3+
description = "Get started with Throne"
4+
weight = 2
5+
sort_by = "weight"
6+
7+
[extra]
8+
+++

‎content/get_started/_index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
+++
2+
title = "Get Started"
3+
description = "Get started with Throne"
4+
weight = 2
5+
sort_by = "weight"
6+
7+
[extra]
8+
+++

0 commit comments

Comments
 (0)