This commit is contained in:
38
.gitea/workflows/deploy.yml
Normal file
38
.gitea/workflows/deploy.yml
Normal file
@@ -0,0 +1,38 @@
|
||||
name: Deploy Docs
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: "3.11"
|
||||
|
||||
- name: Install MkDocs
|
||||
run: pip install -r requirements.txt
|
||||
|
||||
- name: Build
|
||||
run: mkdocs build --strict
|
||||
|
||||
- name: Deploy
|
||||
env:
|
||||
SSH_DEPLOY_KEY: ${{ secrets.SSH_DEPLOY_KEY }}
|
||||
SERVER_USER: ${{ secrets.SERVER_USER }}
|
||||
SERVER_HOST: ${{ secrets.SERVER_HOST }}
|
||||
run: |
|
||||
mkdir -p ~/.ssh
|
||||
echo "$SSH_DEPLOY_KEY" > ~/.ssh/deploy_key
|
||||
chmod 600 ~/.ssh/deploy_key
|
||||
ssh-keyscan -H $SERVER_HOST >> ~/.ssh/known_hosts
|
||||
rsync -avz --delete \
|
||||
-e "ssh -i ~/.ssh/deploy_key" \
|
||||
site/ \
|
||||
$SERVER_USER@$SERVER_HOST:/var/www/foreignthon-docs/
|
||||
3
.gitignore
vendored
Normal file
3
.gitignore
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
site/
|
||||
__pycache__/
|
||||
.DS_Store
|
||||
1
docs/cli-reference.md
Normal file
1
docs/cli-reference.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/contributing/core.md
Normal file
1
docs/contributing/core.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/contributing/language-packs.md
Normal file
1
docs/contributing/language-packs.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/custom-packs.md
Normal file
1
docs/custom-packs.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/dev/architecture.md
Normal file
1
docs/dev/architecture.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/dev/releasing.md
Normal file
1
docs/dev/releasing.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/getting-started.md
Normal file
1
docs/getting-started.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/index.md
Normal file
1
docs/index.md
Normal file
@@ -0,0 +1 @@
|
||||
# ForeignThon
|
||||
1
docs/language-packs.md
Normal file
1
docs/language-packs.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
1
docs/postfix-syntax.md
Normal file
1
docs/postfix-syntax.md
Normal file
@@ -0,0 +1 @@
|
||||
# Coming soon
|
||||
58
mkdocs.yml
Normal file
58
mkdocs.yml
Normal file
@@ -0,0 +1,58 @@
|
||||
site_name: ForeignThon
|
||||
site_url: https://foreignthon.keshavanand.net
|
||||
site_description: Write Python in any human language
|
||||
repo_url: https://git.keshavanand.net/foreign-thon/foreignthon-core
|
||||
repo_name: foreign-thon/foreignthon-core
|
||||
edit_uri: ""
|
||||
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
- scheme: default
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
- scheme: slate
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to light mode
|
||||
features:
|
||||
- navigation.tabs
|
||||
- navigation.sections
|
||||
- navigation.top
|
||||
- navigation.instant
|
||||
- search.highlight
|
||||
- search.suggest
|
||||
- content.code.copy
|
||||
- content.code.annotate
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Getting Started: getting-started.md
|
||||
- CLI Reference: cli-reference.md
|
||||
- Language Packs: language-packs.md
|
||||
- Postfix Syntax: postfix-syntax.md
|
||||
- Custom Packs: custom-packs.md
|
||||
- Contributing:
|
||||
- Core: contributing/core.md
|
||||
- Language Packs: contributing/language-packs.md
|
||||
- Dev:
|
||||
- Architecture: dev/architecture.md
|
||||
- Releasing: dev/releasing.md
|
||||
|
||||
plugins:
|
||||
- search
|
||||
|
||||
markdown_extensions:
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- attr_list
|
||||
- md_in_html
|
||||
- tables
|
||||
- toc:
|
||||
permalink: true
|
||||
2
requirements.txt
Normal file
2
requirements.txt
Normal file
@@ -0,0 +1,2 @@
|
||||
mkdocs>=1.5
|
||||
mkdocs-material>=9.0
|
||||
Reference in New Issue
Block a user