Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
nazarpunk committed Dec 6, 2024
1 parent dab0f01 commit 288f74c
Show file tree
Hide file tree
Showing 11 changed files with 169 additions and 0 deletions.
78 changes: 78 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Build documentation

on:
push:
branches: [ "main" ]
workflow_dispatch:

permissions:
id-token: write
pages: write

env:
INSTANCE: 'Writerside/Moonlight'
ARTIFACT: 'webHelpMOONLIGHT2-all.zip'
DOCKER_VERSION: '242.21870'

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

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

- name: Save artifact with build results
uses: actions/upload-artifact@v4
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }}
artifacts/report.json
retention-days: 7
test:
needs: build
runs-on: ubuntu-latest
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
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 }}
needs: [ build, test ]
runs-on: ubuntu-latest
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
name: docs

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

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

- name: Package and upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: dir

- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/Moonlight.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions Writerside/c.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE categories
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
<categories>
<category id="wrs" name="Writerside documentation" order="1"/>
</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"?>
<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<!-- https://www.jetbrains.com/help/writerside/generate-sitemap.html -->
<sitemap priority="0.35" change-frequency="daily"/>

<build-profile instance="moonlight">
<variables>
<primary-color>ruby</primary-color>
<color-preset>contrast</color-preset>
<noindex-content>false</noindex-content>

<download-title>Скачать UjAPI</download-title>
<download-page>https://github.com/UnryzeC/UjAPI</download-page>
<showDownloadButton>true</showDownloadButton>

<webmaster>[email protected]</webmaster>
<og-image>https://repository-images.githubusercontent.com/878606540/9408810b-00d4-45ad-9667-fc7d23b4718a
</og-image>

<!-- https://www.jetbrains.com/help/writerside/buildprofiles-xml.html#resizable-sidebar -->
<resizable-sidebar>true</resizable-sidebar>

<!-- https://www.jetbrains.com/help/writerside/offline-documentation.html-->
<offline-docs>true</offline-docs>

<!-- https://www.jetbrains.com/help/writerside/buildprofiles-xml.html#content-max-width -->
<content-max-width>99999</content-max-width>
</variables>
</build-profile>

</buildprofiles>
10 changes: 10 additions & 0 deletions Writerside/moonlight.tree
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">

<instance-profile id="moonlight"
name="Moonlight"
start-page="about.md">

<toc-element topic="about.md"/>
</instance-profile>
3 changes: 3 additions & 0 deletions Writerside/topics/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Описание

Здесь будет описание.
5 changes: 5 additions & 0 deletions Writerside/v.list
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
<vars>
<var name="product" value="Writerside"/>
</vars>
8 changes: 8 additions & 0 deletions Writerside/writerside.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">

<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<instance src="moonlight.tree"/>
</ihp>

0 comments on commit 288f74c

Please sign in to comment.