Skip to content

Commit

Permalink
refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
squid233 committed Dec 14, 2024
0 parents commit 99d0a84
Show file tree
Hide file tree
Showing 8 changed files with 169 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
root = true

[*]
charset = utf-8
indent_size = 4
indent_style = space
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false

[*.{yml,json}]
indent_size = 2
56 changes: 56 additions & 0 deletions .github/workflows/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: MkDocs

on:
# Runs on pushes targeting the default branch
push:
branches: [ "main" ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

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

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: 3.12
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install mkdocs
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Build with MkDocs
run: |
mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'site'
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
*~
site
.cache
__pycache__
.idea
7 changes: 7 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
hide:
- navigation
- toc
---

Overrun Organization 成立于2020年6月,目前致力于基础库的开发。
7 changes: 7 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
hide:
- navigation
- toc
---

本网站包含与 Overrun Organization 有关的信息和导航。
20 changes: 20 additions & 0 deletions docs/tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
hide:
- navigation
---

##

<div class="grid cards" markdown>
- [OverrunGL](https://github.com/Over-Run/overrungl)

---

使用 FFM API 的 C 函数绑定库

- [OverrunGL Modules Customizer](https://over-run.github.io/overrungl-gen/)

---

生成 OverrunGL 的依赖定义
</div>
56 changes: 56 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
site_name: Overrun Organization
site_description: Pages of Overrun Organization
site_url: https://over-run.github.io/
site_author: Overrun Organization
copyright: Copyright © 2024 Overrun Organization. Licensed under <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/" target="_blank" rel="noreferrer noopener">CC BY-NC-SA 4.0</a>.

nav:
- 主页: index.md
- 工具: tools.md
- 关于: about.md

validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn

theme:
name: material
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: 切换到浅色模式
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
toggle:
icon: material/brightness-7
name: 切换到深色模式
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
toggle:
icon: material/brightness-4
name: 切换到系统偏好
language: zh
features:
- navigation.instant
- navigation.instant.progress
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.top

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Over-Run

markdown_extensions:
- attr_list
- md_in_html
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
3 changes: 3 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pymdown-extensions
mkdocs-material
mkdocs-rss-plugin

0 comments on commit 99d0a84

Please sign in to comment.