Skip to content
This repository has been archived by the owner on Feb 20, 2024. It is now read-only.

Commit

Permalink
一大堆更新,以及 doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ForteScarlet committed Dec 30, 2023
1 parent 963d685 commit 5309660
Show file tree
Hide file tree
Showing 41 changed files with 1,956 additions and 65 deletions.
104 changes: 104 additions & 0 deletions .github/workflows/deploy-documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
name: Deploy documentation

on:
# If specified, the workflow will be triggered automatically once you push to the `main` branch.
# Replace `main` with your branch’s name
push:
branches:
- main

# Specify to run a workflow manually from the Actions tab on GitHub
workflow_dispatch:

# Gives the workflow permissions to clone the repo and create a page deployment
permissions:
id-token: write
pages: write

env:
# Name of module and id separated by a slash
INSTANCE: Writerside/villa
# Replace HI with the ID of the instance in capital letters
ARTIFACT: webHelpVILLA2-all.zip
# Writerside docker image version
DOCKER_VERSION: 232.10275
# Add the variable below to upload Algolia indexes
# Replace HI with the ID of the instance in capital letters
# ALGOLIA_ARTIFACT: algolia-indexes-HI.zip
jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Build Writerside docs using Docker
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}

- name: Upload documentation
uses: actions/upload-artifact@v3
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }}
artifacts/report.json
retention-days: 7

# Add the step below to upload Algolia indexes
# - name: Upload algolia-indexes
# uses: actions/upload-artifact@v3
# with:
# name: algolia-indexes
# path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
# retention-days: 7

# Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
test:
# Requires build job results
needs: build
runs-on: ubuntu-latest

steps:
- name: Download artifacts
uses: actions/download-artifact@v1
with:
name: docs
path: artifacts

- name: Test documentation
uses: JetBrains/writerside-checker-action@v1
with:
instance: ${{ env.INSTANCE }}

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
# Requires the build job results
needs: test
runs-on: ubuntu-latest
steps:
- name: Download artifact
uses: actions/download-artifact@v3
with:
name: docs

- name: Unzip artifact
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir

- name: Setup Pages
uses: actions/configure-pages@v2

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: dir

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
7 changes: 7 additions & 0 deletions Writerside/c.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="related" name="相关链接" order="1"/>
<category id="external" name="扩展资源" order="2"/>
</categories>
34 changes: 34 additions & 0 deletions Writerside/cfg/buildprofiles.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<?xml version="1.0" encoding="UTF-8"?>
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<variables>
<!-- <primary-color>aqua</primary-color>-->
<custom-favicons>logo-icon.svg</custom-favicons>
<header-logo>logo-icon.svg</header-logo>
<product-web-url>https://github.com/simple-robot/simbot-component-miyoushe-villa</product-web-url>
<download-title>GitHub</download-title>
<download-page>https://github.com/simple-robot/simbot-component-miyoushe-villa</download-page>
<showDownloadButton>true</showDownloadButton>
<browser-edits-url>https://github.com/simple-robot/simbot-component-miyoushe-villa/tree/main/Writerside/</browser-edits-url>
<enable-browser-edits>true</enable-browser-edits>
</variables>

<build-profile instance="villa" >
<variables>
<noindex-content>true</noindex-content>
</variables>
</build-profile>

<footer>
<copyright>%copyright-year% Forte Scarlet.</copyright>
<link href="https://simbot.forte.love/">核心库手册</link>
<link href="https://github.com/simple-robot">组织库</link>
<link href="https://github.com/simple-robot/simpler-robot">核心库仓库</link>
<link href="https://docs.simbot.forte.love/">文档引导站</link>
<link href="https://github.com/orgs/simple-robot/discussions">社区</link>
<link href="https://github.com/simple-robot/simpler-robot/issues">反馈</link>
<social type="bilibili" href="https://space.bilibili.com/2714954" />
<social type="email" href="ForteScarlet@163.com" />
</footer>
</buildprofiles>
7 changes: 7 additions & 0 deletions Writerside/cfg/glossary.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
<terms>
<term name="Simple Robot">高性能全异步的bot风格事件调度框架</term>
<term name="simbot">高性能全异步的bot风格事件调度框架,是Simple Robot的简称</term>
<term name="大别野组件">基于simbot核心库对米游社大别野机器人的组件实现,也包括对API和事件订阅能力的底层库实现模块</term>
</terms>
4 changes: 4 additions & 0 deletions Writerside/help-versions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[
{"version":"1.0","url":"/docs/1.0/","isCurrent":false},
{"version":"2.0","url":"/docs/2.0","isCurrent":true}
]
Loading

0 comments on commit 5309660

Please sign in to comment.