Skip to content

Commit 52cbd46

Browse files
authored
Documentation Site (#2)
* Add documentation. * Add GitHub action.
1 parent b234c9f commit 52cbd46

20 files changed

+864
-0
lines changed

.github/workflows/docs.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: 'Documentation Site'
2+
3+
on:
4+
workflow_dispatch:
5+
6+
jobs:
7+
Build:
8+
runs-on: ubuntu-latest
9+
env:
10+
INSTANCE: 'docs/aockt'
11+
ARTIFACT: 'webHelpAOCKT2-all.zip'
12+
steps:
13+
- name: 'Checkout Repository'
14+
uses: actions/checkout@v4
15+
16+
- name: 'Build Writerside Docs'
17+
uses: JetBrains/writerside-github-action@v4
18+
with:
19+
instance: ${{ env.INSTANCE }}
20+
artifact: ${{ env.ARTIFACT }}
21+
22+
- name: 'Test Writerside Docs'
23+
uses: JetBrains/writerside-checker-action@v1
24+
with:
25+
instance: artifacts/${{ env.INSTANCE }}
26+
27+
- name: 'Unzip Artifact'
28+
run: unzip -qq 'artifacts/${{ env.ARTIFACT }}' -d public
29+
30+
- name: 'Upload Pages Artifact'
31+
uses: actions/upload-pages-artifact@v3
32+
with:
33+
path: ./public
34+
35+
Deploy:
36+
needs: [ Build ]
37+
runs-on: ubuntu-latest
38+
environment:
39+
name: github-pages
40+
url: ${{ steps.deployment.outputs.page_url }}
41+
permissions:
42+
id-token: write
43+
pages: write
44+
steps:
45+
- name: 'Deploy to GitHub Pages'
46+
id: deployment
47+
uses: actions/deploy-pages@v4

docs/aockt.tree

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE instance-profile SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
3+
4+
<instance-profile id="aockt"
5+
name="Advent Of Code Kotlin (AocKt)"
6+
start-page="home.topic">
7+
8+
<toc-element topic="home.topic"/>
9+
<toc-element topic="overview.md"/>
10+
<toc-element topic="workflow.md"/>
11+
<toc-element toc-title="Advanced Use-Cases">
12+
<toc-element topic="project-config.md"/>
13+
<toc-element topic="test-config.md"/>
14+
<toc-element topic="multiple-solutions.md"/>
15+
<toc-element topic="debugging.md"/>
16+
</toc-element>
17+
<toc-element topic="changelog.md"/>
18+
19+
</instance-profile>

docs/c.list

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!DOCTYPE categories SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
2+
<categories>
3+
<category id="related" name="Relevant Further Reading" order="1"/>
4+
</categories>

docs/config/buildprofiles.xml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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>
7+
<!-- Website And SEO -->
8+
<web-root>https://jadarma.github.io/advent-of-code-kotlin</web-root>
9+
<noindex-content>false</noindex-content>
10+
<generate-canonicals>true</generate-canonicals>
11+
12+
<!-- Look And Feel -->
13+
<primary-color>forest</primary-color>
14+
<color-preset>soft</color-preset>
15+
<content-max-width>1200</content-max-width>
16+
17+
<!-- Other -->
18+
<enable-contribution>false</enable-contribution>
19+
<offline-docs>true</offline-docs>
20+
21+
</variables>
22+
23+
<footer>
24+
<copyright>2020-2024 Dan Cristian Cîmpianu | "Advent of Code" is a registered trademark of Eric K. Wastl in the United States.</copyright>
25+
<link href="https://github.com/Jadarma/advent-of-code-kotlin/tree/v%aockt-version%">Source Code</link>
26+
<link href="https://github.com/Jadarma/advent-of-code-kotlin/issues">Issue Tracker</link>
27+
<link href="https://central.sonatype.com/namespace/io.github.jadarma.aockt">Packages</link>
28+
<link href="https://github.com/Jadarma/advent-of-code-kotlin/blob/main/LICENSE.md">License</link>
29+
<link href="https://adventofcode.com">Advent Of Code</link>
30+
</footer>
31+
32+
<build-profile instance="aockt"/>
33+
34+
</buildprofiles>

docs/images/workflow-run-1.png

41 KB
Loading

docs/images/workflow-run-2.png

74.9 KB
Loading

docs/images/workflow-run-3.png

35.1 KB
Loading

docs/images/workflow-run-4.png

27 KB
Loading

docs/images/workflow-run-5.png

23 KB
Loading

docs/images/workflow-run-6.png

56.1 KB
Loading

0 commit comments

Comments
 (0)