Skip to content

Commit 97bff5f

Browse files
berbermanberberman
committed
Initial commit
0 parents  commit 97bff5f

File tree

10 files changed

+229
-0
lines changed

10 files changed

+229
-0
lines changed

‎.github/workflows/build.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Publish docs via GitHub Pages
2+
on:
3+
push:
4+
branches:
5+
- master
6+
7+
jobs:
8+
build:
9+
name: Deploy docs
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout main
13+
uses: actions/checkout@v2
14+
- name: Deploy docs
15+
uses: mhausenblas/mkdocs-deploy-gh-pages@master
16+
env:
17+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
env/
12+
build/
13+
develop-eggs/
14+
dist/
15+
downloads/
16+
eggs/
17+
.eggs/
18+
lib/
19+
lib64/
20+
node_modules/
21+
parts/
22+
sdist/
23+
var/
24+
package*.json
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.coverage
43+
.coverage.*
44+
.cache
45+
nosetests.xml
46+
coverage.xml
47+
*,cover
48+
.hypothesis/
49+
50+
# Translations
51+
*.mo
52+
53+
# Scrapy stuff:
54+
.scrapy
55+
56+
# PyBuilder
57+
target/
58+
59+
# IPython Notebook
60+
.ipynb_checkpoints
61+
62+
# pyenv
63+
.python-version
64+
65+
# virtualenv
66+
venv/
67+
ENV/
68+
69+
# MkDocs documentation
70+
site*/

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# fcitx5-android.github.io
2+
3+
Documentation for fcitx5-android.
4+
5+
## Build
6+
7+
You an install `mkdocs-material` via `pip`.
8+

‎docs/assets/ic_launcher_legacy_source.png‎

9.9 KB
Loading

‎docs/index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
6+
# 欢迎访问 Fcitx5 for Android 文档
7+
8+
* 在 Trello 看板查看开发进程与计划：<https://trello.com/b/gftk6ZdV/kanban>
9+
* 加入 Matrix 聊天室：<https://matrix.to/#/#fcitx5-android:mozilla.org>
10+
* 加入 Telegram 群聊：<https://t.me/+hci-DrFVWUM3NTUx>
11+
12+
Telegram 群与 Matrix 聊天室是互通的。

‎docs/installation.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# 安装
2+
3+
您可以在 [Jenkins](https://jenkins.fcitx-im.org/job/android/job/fcitx5-android/) 上下载到最新构建的 apk 安装包。您也可以通过 [更新器](#_2) 来下载并管理版本。
4+
5+
## 更新器
6+
7+
更新器是一个独立的应用，它可以获取并安装位于 Jenkins 上最近几次构建的 apk 安装包。目前，更新器仍是进展中的项目，它不在 Jenkins 上构建并分发二进制。您可以在 <https://github.com/fcitx5-android/fcitx5-android-updater> 获取它的源码自行构建安装。
8+
9+
> 您也可以在 [Telegram 群](index.md)中获取开发者临时构建签名的版本。

‎flake.lock‎

Lines changed: 44 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎flake.nix‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
description = "Docs for fcitx5-android";
3+
4+
inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
5+
inputs.flake-compat = {
6+
url = "github:edolstra/flake-compat";
7+
flake = false;
8+
};
9+
10+
outputs = { self, nixpkgs, ... }:
11+
let pkgs = nixpkgs.legacyPackages.x86_64-linux;
12+
in with pkgs; {
13+
devShells.x86_64-linux.default = mkShell {
14+
buildInputs = with python3Packages; [ mkdocs mkdocs-material ];
15+
};
16+
};
17+
18+
}

‎mkdocs.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
site_name: Fcitx5 For Android
2+
theme:
3+
name: material
4+
palette:
5+
primary: teal
6+
accent: teal
7+
language: zh
8+
favicon: assets/ic_launcher_legacy_source.png
9+
logo: assets/ic_launcher_legacy_source.png
10+
features:
11+
- navigation.instant
12+
- navigation.tracking
13+
- navigation.tabs
14+
- navigation.tabs.sticky
15+
- toc.integrate
16+
- navigation.top
17+
site_url: https://fcitx5-android.github.io
18+
19+
nav:
20+
- 主页: index.md
21+
- 安装: installation.md
22+
23+
repo_url: https://github.com/fcitx5-android/fcitx5-android.github.io
24+
25+
markdown_extensions:
26+
- toc:
27+
permalink: "#"
28+
- admonition
29+
- footnotes
30+
- meta
31+
- pymdownx.caret
32+
- pymdownx.tilde
33+
- pymdownx.critic
34+
- pymdownx.details
35+
- pymdownx.inlinehilite
36+
- pymdownx.mark
37+
- pymdownx.smartsymbols
38+
- pymdownx.superfences
39+
- codehilite:
40+
guess_lang: false
41+
linenums: true
42+
- pymdownx.arithmatex
43+
- pymdownx.betterem:
44+
smart_enable: all
45+
- pymdownx.tasklist

‎shell.nix‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
(import (let lock = builtins.fromJSON (builtins.readFile ./flake.lock);
2+
in fetchTarball {
3+
url =
4+
"https://github.com/edolstra/flake-compat/archive/${lock.nodes.flake-compat.locked.rev}.tar.gz";
5+
sha256 = lock.nodes.flake-compat.locked.narHash;
6+
}) { src = ./.; }).shellNix

0 commit comments

Comments
 (0)