Skip to content

Commit 56aab3d

Browse files
categoric-devcategoric-dev
committed
Initial commit
0 parents  commit 56aab3d

25 files changed

Lines changed: 1046 additions & 0 deletions

‎.github/workflows/build-docs.yml‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
name: Build documentation
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
id-token: write
11+
pages: write
12+
13+
env:
14+
INSTANCE: 'Writerside/h'
15+
DOCKER_VERSION: '243.22562'
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
outputs:
21+
algolia_artifact: ${{ steps.define-ids.outputs.algolia_artifact }}
22+
artifact: ${{ steps.define-ids.outputs.artifact }}
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
with:
27+
fetch-depth: 0
28+
29+
- name: Define instance id and artifacts
30+
id: define-ids
31+
run: |
32+
INSTANCE=${INSTANCE#*/}
33+
INSTANCE_ID_UPPER=$(echo "$INSTANCE" | tr '[:lower:]' '[:upper:]')
34+
ARTIFACT="webHelp${INSTANCE_ID_UPPER}2-all.zip"
35+
ALGOLIA_ARTIFACT="algolia-indexes-${INSTANCE_ID_UPPER}.zip"
36+
37+
# Print the values
38+
echo "INSTANCE_ID_UPPER: $INSTANCE_ID_UPPER"
39+
echo "ARTIFACT: $ARTIFACT"
40+
echo "ALGOLIA_ARTIFACT: $ALGOLIA_ARTIFACT"
41+
42+
# Set the environment variables and outputs
43+
echo "INSTANCE_ID_UPPER=$INSTANCE_ID_UPPER" >> $GITHUB_ENV
44+
echo "ARTIFACT=$ARTIFACT" >> $GITHUB_ENV
45+
echo "ALGOLIA_ARTIFACT=$ALGOLIA_ARTIFACT" >> $GITHUB_ENV
46+
echo "artifact=$ARTIFACT" >> $GITHUB_OUTPUT
47+
echo "algolia_artifact=$ALGOLIA_ARTIFACT" >> $GITHUB_OUTPUT
48+
49+
- name: Build docs using Writerside Docker builder
50+
uses: JetBrains/writerside-github-action@v4
51+
with:
52+
instance: ${{ env.INSTANCE }}
53+
docker-version: ${{ env.DOCKER_VERSION }}
54+
55+
- name: Save artifact with build results
56+
uses: actions/upload-artifact@v4
57+
with:
58+
name: docs
59+
path: |
60+
artifacts/${{ steps.define-ids.outputs.artifact }}
61+
artifacts/report.json
62+
artifacts/${{ steps.define-ids.outputs.algolia_artifact }}
63+
retention-days: 7
64+
test:
65+
needs: build
66+
runs-on: ubuntu-latest
67+
steps:
68+
- name: Download artifacts
69+
uses: actions/download-artifact@v4
70+
with:
71+
name: docs
72+
path: artifacts
73+
74+
- name: Test documentation
75+
uses: JetBrains/writerside-checker-action@v1
76+
with:
77+
instance: ${{ env.INSTANCE }}
78+
deploy:
79+
environment:
80+
name: github-pages
81+
url: ${{ steps.deployment.outputs.page_url }}
82+
needs: [build, test]
83+
runs-on: ubuntu-latest
84+
steps:
85+
- name: Download artifacts
86+
uses: actions/download-artifact@v4
87+
with:
88+
name: docs
89+
path: artifacts
90+
91+
- name: Unzip artifact
92+
run: unzip -O UTF-8 -qq "artifacts/${{ needs.build.outputs.artifact }}" -d dir
93+
94+
- name: Setup Pages
95+
uses: actions/configure-pages@v4
96+
97+
- name: Package and upload Pages artifact
98+
uses: actions/upload-pages-artifact@v3
99+
with:
100+
path: dir
101+
102+
- name: Deploy to GitHub Pages
103+
id: deployment
104+
uses: actions/deploy-pages@v4

‎.gitignore‎

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

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 categoric-dev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎Writerside/c.list‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE categories
3+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
4+
<categories>
5+
<category id="wrs" name="Writerside documentation" order="1"/>
6+
</categories>

‎Writerside/cfg/buildprofiles.xml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
3+
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
5+
6+
<variables></variables>
7+
<build-profile instance="h">
8+
<variables>
9+
<noindex-content>true</noindex-content>
10+
<custom-css>custom.css</custom-css>
11+
</variables>
12+
</build-profile>
13+
<build-profile instance="t">
14+
<variables>
15+
<noindex-content>true</noindex-content>
16+
</variables>
17+
</build-profile>
18+
</buildprofiles>

‎Writerside/cfg/css/custom.css‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
body {
2+
margin: 1em;
3+
font: 1.2rem/1.4 Georgia, serif;
4+
}
5+
.quote {
6+
margin: 0;
7+
background: #eee;
8+
padding: 1em;
9+
border-radius: 1em;
10+
}
11+
.quote figcaption,
12+
.quote blockquote {
13+
margin: 1em;
14+
}

‎Writerside/h.tree‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
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="h"
6+
name="Home"
7+
start-page="starter-topic.md">
8+
9+
<toc-element topic="Sociology.md">
10+
<toc-element topic="Organization.md"/>
11+
<toc-element topic="Institutions.md">
12+
<toc-element topic="IEEE.md"/>
13+
</toc-element>
14+
</toc-element>
15+
<toc-element topic="Philosophy.md">
16+
<toc-element topic="Epistemology.md">
17+
<toc-element topic="Knowledge.md"/>
18+
</toc-element>
19+
</toc-element>
20+
<toc-element topic="starter-topic.md">
21+
</toc-element>
22+
</instance-profile>

‎Writerside/images/completion_procedure.png‎

125 KB
Loading

‎Writerside/images/completion_procedure_dark.png‎

67.1 KB
Loading

‎Writerside/images/convert_table_to_xml.png‎

341 KB
Loading

0 commit comments

Comments
 (0)