Skip to content

Commit 511da87

Browse files
harrel56harrel56
authored
Merge pull request #307 from harrel56/doc/init-writerside-docs
Doc/Writerside docs
2 parents 6c89b60 + 8ac78b0 commit 511da87

44 files changed

Lines changed: 2718 additions & 1341 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Build documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
outputs:
13+
artifact: ${{ steps.define-ids.outputs.artifact }}
14+
steps:
15+
- name: Checkout repository
16+
uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
20+
- name: Build docs using Writerside Docker builder
21+
uses: JetBrains/writerside-github-action@v4
22+
with:
23+
instance: 'docs/json-schema-docs'
24+
docker-version: '2025.04.8412'
25+
26+
- name: Save artifact with build results
27+
uses: actions/upload-artifact@v4
28+
with:
29+
name: docs
30+
path: |
31+
artifacts/webHelpJSON-SCHEMA-DOCS2-all.zip
32+
33+
deploy:
34+
environment:
35+
name: github-pages
36+
url: ${{ steps.deployment.outputs.page_url }}
37+
needs: [ build ]
38+
runs-on: ubuntu-latest
39+
permissions:
40+
pages: write
41+
id-token: write
42+
steps:
43+
- name: Download artifacts
44+
uses: actions/download-artifact@v4
45+
with:
46+
name: docs
47+
48+
- name: Unzip artifact
49+
run: unzip -O UTF-8 -qq "webHelpJSON-SCHEMA-DOCS2-all.zip" -d dir
50+
51+
- name: Setup Pages
52+
uses: actions/configure-pages@v4
53+
54+
- name: Package and upload Pages artifact
55+
uses: actions/upload-pages-artifact@v3
56+
with:
57+
path: dir
58+
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v4

‎README.md‎

Lines changed: 12 additions & 364 deletions
Large diffs are not rendered by default.

‎docs/c.list‎

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 categories
3+
SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
4+
<categories>
5+
</categories>

‎docs/cfg/buildprofiles.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
<build-profile instance="json-schema-docs">
7+
<variables>
8+
<noindex-content>false</noindex-content>
9+
<primary-color>iris</primary-color>
10+
<showDownloadButton>true</showDownloadButton>
11+
<download-page>https://harrel.dev/json-schema</download-page>
12+
<download-title>Try online validator</download-title>
13+
<enable-contribution>true</enable-contribution>
14+
<contribute-url>https://github.com/harrel56/json-schema/tree/master/Writerside</contribute-url>
15+
<product-web-url>https://github.com/harrel56/json-schema</product-web-url>
16+
</variables>
17+
<footer>
18+
<social type="github" href="https://github.com/harrel56/json-schema">Github repository</social>
19+
<link href="https://harrel.dev">Homepage</link>
20+
<link href="https://harrel.dev/json-schema">Online validator</link>
21+
<link href="https://javadoc.io/doc/dev.harrel/json-schema">JavaDoc</link>
22+
<link href="https://mvnrepository.com/artifact/dev.harrel/json-schema">Maven</link>
23+
</footer>
24+
</build-profile>
25+
26+
</buildprofiles>

‎docs/json-schema-docs.tree‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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="json-schema-docs"
6+
name="dev.harrel:json-schema"
7+
start-page="about.md">
8+
9+
<toc-element toc-title="Getting started">
10+
<toc-element topic="about.md"/>
11+
<toc-element topic="Installation.md"/>
12+
<toc-element topic="JSON-YAML-providers.md">
13+
<toc-element topic="Jackson.md"/>
14+
<toc-element topic="Gson.md"/>
15+
<toc-element topic="JSON-org.md"/>
16+
<toc-element topic="Jakarta-JSON.md"/>
17+
<toc-element topic="Kotlinx-serialization.md"/>
18+
<toc-element topic="SnakeYAML.md"/>
19+
<toc-element topic="JSON-smart.md"/>
20+
<toc-element topic="Jettison.md"/>
21+
</toc-element>
22+
</toc-element>
23+
<toc-element topic="Basic-usage.md"/>
24+
<toc-element topic="Format-validation.md"/>
25+
<toc-element topic="Dialects.md"/>
26+
<toc-element topic="Resolving-schemas.md">
27+
<toc-element topic="Resolver-examples.md"/>
28+
</toc-element>
29+
<toc-element topic="Annotations.md"/>
30+
<toc-element toc-title="Advanced configuration">
31+
<toc-element toc-title="Custom keywords">
32+
<toc-element topic="Evaluators.md"/>
33+
<toc-element topic="Evaluator-factories.md"/>
34+
<toc-element toc-title="Examples">
35+
<toc-element topic="Custom-keyword-maximum-size.md"/>
36+
<toc-element topic="Custom-keyword-property-with-shortest-name.md"/>
37+
<toc-element topic="Custom-keyword-lenient-type.md"/>
38+
</toc-element>
39+
</toc-element>
40+
<toc-element toc-title="Custom dialects">
41+
<toc-element topic="Custom-dialects-details.md"/>
42+
<toc-element toc-title="Examples">
43+
<toc-element topic="Custom-dialect-format-assertions.md"/>
44+
<toc-element topic="Custom-vocabulary.md"/>
45+
<toc-element topic="Dialect-overwrite.md"/>
46+
</toc-element>
47+
</toc-element>
48+
<toc-element topic="Custom-JSON-YAML-providers.md"/>
49+
</toc-element>
50+
</instance-profile>

0 commit comments

Comments
 (0)