From 5d7f4a7d54da1091e2c314584141f8099ff9ab31 Mon Sep 17 00:00:00 2001 From: LittleSheep Date: Fri, 5 Apr 2024 12:33:44 +0800 Subject: [PATCH] :tada: Inital Commit --- .gitignore | 1 + docs/en/hydrogen/.pages | 3 ++ docs/en/hydrogen/identity/.pages | 2 ++ docs/en/hydrogen/identity/index.md | 47 ++++++++++++++++++++++++++++++ docs/en/hydrogen/index.md | 24 +++++++++++++++ docs/en/index.md | 13 +++++++++ mkdocs.yml | 44 ++++++++++++++++++++++++++++ requirements.txt | 33 +++++++++++++++++++++ 8 files changed, 167 insertions(+) create mode 100644 .gitignore create mode 100644 docs/en/hydrogen/.pages create mode 100644 docs/en/hydrogen/identity/.pages create mode 100644 docs/en/hydrogen/identity/index.md create mode 100644 docs/en/hydrogen/index.md create mode 100644 docs/en/index.md create mode 100644 mkdocs.yml create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..91078ac --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/env diff --git a/docs/en/hydrogen/.pages b/docs/en/hydrogen/.pages new file mode 100644 index 0000000..d4aaebb --- /dev/null +++ b/docs/en/hydrogen/.pages @@ -0,0 +1,3 @@ +nav: + - Introduction: index.md + - Hydrogen.Identity: identity \ No newline at end of file diff --git a/docs/en/hydrogen/identity/.pages b/docs/en/hydrogen/identity/.pages new file mode 100644 index 0000000..0614bfa --- /dev/null +++ b/docs/en/hydrogen/identity/.pages @@ -0,0 +1,2 @@ +nav: + - index.md \ No newline at end of file diff --git a/docs/en/hydrogen/identity/index.md b/docs/en/hydrogen/identity/index.md new file mode 100644 index 0000000..c771366 --- /dev/null +++ b/docs/en/hydrogen/identity/index.md @@ -0,0 +1,47 @@ +# Hydrogen.Identity + +This product also knows as Solarpass. + +It provide an identity service for all Hydrogen Projects. You can access it from +[id.solsynth.dev](https://id.solsynth.dev). + +## Beginning + +To start use Solarpass, you can create an account. The flow to create account is pretty simple. +The only things you need to notice is the name is need to be unique and cannot editable after signed up. + +Also your nick cannot be shorter than 4 character. If any rules you didn't followed up, you request will be rejected. + +## Notorious MFA + +We implement MFA as the main way to access your account. It should be pretty awesome. But the fact is the MFA detection system will require you receive an email from any new device (we use IP to detect if you use a new device). + +Which is means if you use any proxy or VPN to against the censorship from China. You will be ask for the email verification code every times you try to sign in. + +So disable the VPN for access our website. We deploy our frontend to Cloudflare and hosted backend with our own machine. Both of them didn't in the blacklist of GFW yet. + +(Our own server is located at Hong Kong) + +## Personalize + +We bring a awesome personal feature to you since ...(I forgot which version we published it). + +But you can edit your avatar from Solian. It will display in front of your posts and messages. +You also can edit your banner, it will display at your personal page. + +You can modify your bio(which is description), display name and real name too. +It just above the personal image part. + +## Personal page + +This feature provide a space for you to customize your personal page. +You can write some markdown or html either. + +We didn't do much of XSS defense at this part. All elements are allowed. +You can write a form or embed a rick roll video on your personal page too. + +But I don't think so trick users personal info is a good idea for design your personal page. +If we find you use this feature to do some thing against our Term of Service or local laws. +We will suspend your account forever. + +Think twice! \ No newline at end of file diff --git a/docs/en/hydrogen/index.md b/docs/en/hydrogen/index.md new file mode 100644 index 0000000..d79d738 --- /dev/null +++ b/docs/en/hydrogen/index.md @@ -0,0 +1,24 @@ +# Project Hydrogen + +Hola! This is official wiki of Project Hydrogen! + +You can find how to use Project Hydrogen here. + +Most of example we will using our official Project Hydrogen instance. Also the biggest one. + +Solar Network [Click to join](https://lian.solsynth.dev) + +## How to report issue + +You can open our [Code Repository](https://git.solsynth.dev/Hydrogen). +And then open the product repo as you want. + +You can sign in with your Solarpass. After that create a issue in product repo (or knows as 工单). +Our member will follow up as soon as possible. + +You'd better attach some screenshot, error message and reproduce ways, +if some problem cannot reproduce, we cannot fix it. + +----- + +Enjoy! diff --git a/docs/en/index.md b/docs/en/index.md new file mode 100644 index 0000000..6b0f191 --- /dev/null +++ b/docs/en/index.md @@ -0,0 +1,13 @@ +--- +title: Intro +--- + +# Welcome to Goatpedia + +This is the documentation hell of All Solsynth products. +You can find all of their documentation here. +If you cannot find some of them documentation, it means we didn't provide documentation for that product (LAMO). + +If you have some issue. Don't forgot to join our chat server! + +[Join Solar Network - Hydrogen.Messaging](https://lian.solsynth.dev/chat/solar-networks) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ffd4fa3 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,44 @@ +site_name: Goatpedia +theme: + name: material + palette: + - media: "(prefers-color-scheme)" + toggle: + icon: material/brightness-auto + name: Switch to light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to system preference + features: + - navigation.instant + - navigation.instant.progress + - navigation.tracking + - navigation.tabs + - navigation.expand + - navigation.prune + - navigation.indexes + - toc.follow + - navigation.top + - search.suggest + - search.highlight + - search.share +plugins: + - search + - awesome-pages + - i18n: + docs_structure: folder + languages: + - locale: en + default: true + name: English + build: true + - locale: zh + name: Simplified Chinese + build: true diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f263640 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,33 @@ +Babel==2.14.0 +bracex==2.4 +certifi==2024.2.2 +charset-normalizer==3.3.2 +click==8.1.7 +colorama==0.4.6 +ghp-import==2.1.0 +idna==3.6 +Jinja2==3.1.3 +Markdown==3.6 +MarkupSafe==2.1.5 +mergedeep==1.3.4 +mkdocs==1.5.3 +mkdocs-awesome-pages-plugin==2.9.2 +mkdocs-material==9.5.17 +mkdocs-material-extensions==1.3.1 +mkdocs-static-i18n==1.2.2 +natsort==8.4.0 +packaging==24.0 +paginate==0.5.6 +pathspec==0.12.1 +platformdirs==4.2.0 +Pygments==2.17.2 +pymdown-extensions==10.7.1 +python-dateutil==2.9.0.post0 +PyYAML==6.0.1 +pyyaml_env_tag==0.1 +regex==2023.12.25 +requests==2.31.0 +six==1.16.0 +urllib3==2.2.1 +watchdog==4.0.0 +wcmatch==8.5.1