Skip to content

Commit 451256e

Browse files
SerafimArtsSerafimArts
committed
Initial commit
0 parents  commit 451256e

20 files changed

Lines changed: 587 additions & 0 deletions

β€Ž.github/workflows/deploy.ymlβ€Ž

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: Build Documentation
2+
3+
on:
4+
push:
5+
branches: ["master"]
6+
# Specify to run a workflow manually from the Actions tab on GitHub
7+
workflow_dispatch:
8+
9+
# Gives the workflow permissions to clone the repo and create a page deployment
10+
permissions:
11+
id-token: write
12+
pages: write
13+
14+
env:
15+
# Name of module and id separated by a slash
16+
INSTANCE: Writerside/tl
17+
# Replace HI with the ID of the instance in capital letters
18+
ARTIFACT: webHelpTL2-all.zip
19+
# Writerside docker image version
20+
DOCKER_VERSION: '243.21565'
21+
ALGOLIA_ARTIFACT: 'algolia-indexes-TL.zip'
22+
ALGOLIA_APP_NAME: 'CZXH99BXN1'
23+
ALGOLIA_INDEX_NAME: 'Writerside'
24+
ALGOLIA_KEY: '${{ secrets.ALGOLIA_KEY }}'
25+
CONFIG_JSON_PRODUCT: 'TL'
26+
CONFIG_JSON_VERSION: '1.0'
27+
28+
jobs:
29+
build:
30+
runs-on: ubuntu-latest
31+
32+
steps:
33+
- name: Checkout Repository
34+
uses: actions/checkout@v4
35+
with:
36+
fetch-depth: 0
37+
- name: Build Docs
38+
uses: JetBrains/writerside-github-action@v4
39+
with:
40+
instance: ${{ env.INSTANCE }}
41+
artifact: ${{ env.ARTIFACT }}
42+
docker-version: ${{ env.DOCKER_VERSION }}
43+
- name: Upload Documentation
44+
uses: actions/upload-artifact@v4
45+
with:
46+
name: docs
47+
path: |
48+
artifacts/${{ env.ARTIFACT }}
49+
artifacts/report.html
50+
artifacts/report.json
51+
artifacts/${{ env.ALGOLIA_ARTIFACT }}
52+
retention-days: 7
53+
54+
test:
55+
needs: build
56+
runs-on: ubuntu-latest
57+
steps:
58+
- name: Download Artifacts
59+
uses: actions/download-artifact@v4
60+
with:
61+
name: docs
62+
path: artifacts
63+
- name: Test Documentation
64+
uses: JetBrains/writerside-checker-action@v1
65+
with:
66+
instance: ${{ env.INSTANCE }}
67+
68+
deploy:
69+
environment:
70+
name: github-pages
71+
url: ${{ steps.deployment.outputs.page_url }}
72+
needs: test
73+
runs-on: ubuntu-latest
74+
steps:
75+
- name: Download Artifact
76+
uses: actions/download-artifact@v4
77+
with:
78+
name: docs
79+
- name: Unzip Artifact
80+
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
81+
- name: Setup Pages
82+
uses: actions/configure-pages@v4
83+
- name: Upload Artifact
84+
uses: actions/upload-pages-artifact@v3
85+
with:
86+
path: dir
87+
- name: Deploy to GitHub Pages
88+
id: deployment
89+
uses: actions/deploy-pages@v4
90+
91+
publish-indexes:
92+
needs: [build, test, deploy]
93+
runs-on: ubuntu-latest
94+
container:
95+
image: registry.jetbrains.team/p/writerside/builder/algolia-publisher:2.0.32-3
96+
steps:
97+
- name: Download artifact
98+
uses: actions/download-artifact@v4
99+
with:
100+
name: docs
101+
- name: Unzip artifact
102+
run: |
103+
unzip -O UTF-8 -qq '${{ env.ALGOLIA_ARTIFACT }}' -d algolia-indexes
104+
env algolia-key='${{env.ALGOLIA_KEY}}' java -jar /opt/builder/help-publication-agent.jar \
105+
update-index \
106+
--application-name '${{env.ALGOLIA_APP_NAME}}' \
107+
--index-name '${{env.ALGOLIA_INDEX_NAME}}' \
108+
--product '${{env.CONFIG_JSON_PRODUCT}}' \
109+
--version '${{env.CONFIG_JSON_VERSION}}' \
110+
--index-directory algolia-indexes/ \
111+
2>&1 | tee algolia-update-index-log.txt

β€Ž.gitignoreβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/.idea

β€ŽWriterside/boson.treeβ€Ž

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE instance-profile
3+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
4+
5+
<instance-profile id="boson" name="BOSON" is-library="true" start-page="overview.topic">
6+
<toc-element topic="overview.topic" />
7+
8+
<toc-element topic="release-notes.md" />
9+
<toc-element topic="contribution.md" />
10+
<toc-element topic="license.md" />
11+
12+
</instance-profile>

β€ŽWriterside/cfg/buildprofiles.xmlβ€Ž

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
4+
<sitemap priority="0.35" change-frequency="monthly"/>
5+
6+
<variables>
7+
<primary-color>#558EBA</primary-color>
8+
<link-color>#558EBA</link-color>
9+
<color-preset>contrast</color-preset>
10+
<custom-favicons>logo.webp</custom-favicons>
11+
<header-logo>logo.webp</header-logo>
12+
<product-web-url>https://nesk.me</product-web-url><!-- TODO -->
13+
<noindex-content>false</noindex-content>
14+
<offline-docs>false</offline-docs>
15+
16+
<feedback-url>https://github.com/BosonPHP/Docs/issues</feedback-url>
17+
<web-root>/</web-root>
18+
<og-image>splash.png</og-image>
19+
<generate-canonicals>true</generate-canonicals>
20+
21+
<download-title>GitHub</download-title>
22+
<download-page>https://github.com/php-type-language</download-page>
23+
<showDownloadButton>true</showDownloadButton>
24+
25+
<enable-contribution>true</enable-contribution>
26+
<contribute-url>https://github.com/BosonPHP/Docs/blob/master/Writerside/</contribute-url>
27+
<custom-css>custom.css</custom-css>
28+
29+
<algolia-id>CZXH99BXN1</algolia-id>
30+
<algolia-index>Writerside</algolia-index>
31+
<algolia-api-key>70b2d5249859c00508d22cb54c52eeee</algolia-api-key>
32+
</variables>
33+
34+
<icons>
35+
<local-src>icons</local-src>
36+
</icons>
37+
38+
<footer>
39+
<social href="https://github.com/BosonPHP" type="blog">GitHub</social>
40+
<link href="https://packagist.org/packages/boson-php">Packagist</link>
41+
<link href="https://github.com/BosonPHP/Runtime/issues">Issue tracker</link>
42+
<link href="https://github.com/BosonPHP/Runtime/pulls">Submit request</link>
43+
<copyright>Boson</copyright>
44+
</footer>
45+
</buildprofiles>

β€ŽWriterside/cfg/glossary.xmlβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
3+
<terms>
4+
<term name="FQN">Fully Qualified Name</term>
5+
</terms>

β€ŽWriterside/cfg/static/custom.cssβ€Ž

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
:root {
2+
--wh-color-accent-substrate-bg: #284E6D !important;
3+
--wh-color-border-hover: #558EBA !important;
4+
--wh-color-backlight-pale: none;
5+
--wh-color-backlight-pale-dark: none;
6+
}
7+
8+
.wh-header__product-logo {
9+
width: auto;
10+
height: 48px;
11+
}
12+
13+
.article > .prompt {
14+
max-width: auto !important;
15+
}
16+
17+
.prompt__wrapper {
18+
display: flex;
19+
}
20+
21+
.prompt__content {
22+
overflow: visible;
23+
}
24+
25+
.prompt__wrapper > .prompt__content {
26+
flex: 1;
27+
}
28+
29+
.app__nav {
30+
padding: 0 10px;
31+
}
32+
33+
.app__sidebar {
34+
border: none;
35+
}
36+
37+
.app__toc li {
38+
margin: 6px 0;
39+
}
40+
41+
.toc-item {
42+
border-radius: 5px;
43+
}
44+
45+
.toc-item--highlighted {
46+
// background: none;
47+
}
48+
49+
.article__list + .code-block__wrapper,
50+
.article__list + .code-collapse__wrapper,
51+
p + .code-block__wrapper,
52+
p + .code-collapse__wrapper,
53+
.code-block__wrapper + .code-collapse__wrapper,
54+
.code-block__wrapper + .code-block__wrapper {
55+
margin-top: 12px !important;
56+
}
57+
58+
.starting-page-card {
59+
border-radius: 7px;
60+
}
61+
62+
.starting-page-card:hover {
63+
}
64+
65+
#mermaid .flowchart-link {
66+
stroke: #284E6D !important;
67+
}

β€ŽWriterside/icons/class.svgβ€Ž

Lines changed: 1 addition & 0 deletions
Loading

β€ŽWriterside/icons/ko.svgβ€Ž

Lines changed: 4 additions & 0 deletions
Loading

β€ŽWriterside/icons/ok.svgβ€Ž

Lines changed: 4 additions & 0 deletions
Loading

β€ŽWriterside/icons/unknown.svgβ€Ž

Lines changed: 4 additions & 0 deletions
Loading

0 commit comments

Comments
Β (0)