aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2023-07-25 13:13:13 +0800
committer简律纯 <i@jyunko.cn>2023-07-25 13:13:13 +0800
commit3573c1603e94baa411514646ab1a83f4ad5f9144 (patch)
tree2f9f5f4d68d419595b631f2e23920de7314f9083
parentba2d8a5f64c2a0717a1c6a05302da9071c0b33d0 (diff)
downloadTRPGNivis-3573c1603e94baa411514646ab1a83f4ad5f9144.tar.gz
TRPGNivis-3573c1603e94baa411514646ab1a83f4ad5f9144.zip
url
-rw-r--r--docs/mkdocs.yml7
-rw-r--r--docs/requirements.txt3
-rw-r--r--readme.rst14
3 files changed, 21 insertions, 3 deletions
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 415a321..cd1570d 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -1,8 +1,11 @@
site_name: Psi Docs (Draft)
repo_url: https://github.com/HydroRoll-Team/psi
repo_name: HydroRoll-Team/psi
-edit_uri: edit/main/docs/
-
+edit_uri: edit/main/docs/docs/
+site_author: Hsiang Nianian
+site_description: >-
+ Psi is a new programming language designed with simplicity, flexibility, and performance in mind.
+ It provides a clean and intuitive syntax that is easy to read and write, making it an excellent choice for both beginners and experienced programmers.
theme:
name: material
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 591b791..b27a670 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,4 +1,5 @@
mkdocs-material
mkdocs-blog-plugin
mkdocs-git-revision-date-localized-plugin
-mkdocs-git-authors-plugin \ No newline at end of file
+mkdocs-git-authors-plugin
+mkdocs-material-extensions>=1.1 \ No newline at end of file
diff --git a/readme.rst b/readme.rst
index 165fcd7..b2089c0 100644
--- a/readme.rst
+++ b/readme.rst
@@ -82,6 +82,20 @@ How to build docs
mkdocs serve
+Documentation
+-------------
+
+Psi documentation is available at `retrofor <https://hydroroll-team.github.io/psi>`_.
+
+You can also view it throw the following links:
+
+ `vercel-1 <https://psi-alpha.vercel.app>`_
+
+ `vercel-2 <https://psi-retrofor.vercel.app>`_
+
+ `gh-pages <https://hydroroll-team.github.io/psi`_
+
+
License
-------