Skip to content

Commit 4e96196

Browse files
gclaussngclaussn
committed
docs: create documentation for v0.1.0
1 parent bf3da8a commit 4e96196

21 files changed

+1198
-1
lines changed

‎astro.config.mjs‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
5+
// https://astro.build/config
6+
export default defineConfig({
7+
site: 'https://gclaussn.github.io',
8+
base: 'go-bpmn',
9+
integrations: [
10+
starlight({
11+
title: 'go-bpmn',
12+
social: [{ icon: 'github', label: 'GitHub', href: 'https://github.com/gclaussn/go-bpmn' }],
13+
sidebar: [
14+
{
15+
label: 'Getting started',
16+
items: [
17+
{ label: 'Introduction', slug: 'getting-started/introduction' },
18+
{ label: 'Automate a process', slug: 'getting-started/automate-process' },
19+
],
20+
},
21+
{
22+
label: 'Guides',
23+
items: [
24+
{ label: 'Installation', slug: 'guides/installation' },
25+
{ label: 'Run a process engine', slug: 'guides/run-process-engine' },
26+
{ label: 'Using CLI', slug: 'guides/using-cli' },
27+
],
28+
},
29+
{
30+
label: 'Reference',
31+
items: [
32+
{ label: 'BPMN 2.0 coverage', slug: 'reference/bpmn-coverage' },
33+
{ label: 'API documentation', slug: 'reference/api-documentation' },
34+
],
35+
},
36+
],
37+
}),
38+
],
39+
});

‎package.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
"name": "go-bpmn-docs",
33
"type": "module",
44
"version": "v0.1.0",
5+
"engines": {
6+
"node": ">=20.11.0",
7+
"npm": ">=10.2.4"
8+
},
59
"scripts": {
610
"dev": "astro dev",
711
"start": "astro dev",
@@ -14,4 +18,4 @@
1418
"astro": "^5.6.1",
1519
"sharp": "^0.32.5"
1620
}
17-
}
21+
}

‎public/favicon.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎public/getting-started/automate-process/example.svg‎

Lines changed: 4 additions & 0 deletions
Loading

‎src/assets/release.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"version": "v0.1.0",
3+
"artifacts": [
4+
{
5+
"os": "linux",
6+
"osarch": "linux-amd64",
7+
"checksum": "0e54a07819f4618522080d4b41bcbae42c912d3c0d48d04fad0a628974dc4dc4"
8+
},
9+
{
10+
"os": "windows",
11+
"osarch": "windows-amd64",
12+
"checksum": "1afdbf97d9cbe2a2d5a9c659d215cda28c0c687ac2ea73acf2ce762741e64c2c"
13+
}
14+
]
15+
}

‎src/components/BpmnEvent.astro‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
const { label } = Astro.props;
3+
---
4+
5+
<div style="display: flex; justify-content: center">
6+
<div>
7+
<div>
8+
<svg width="70" height="48">
9+
<g transform="translate(17, 6)">
10+
<slot />
11+
</g>
12+
</svg>
13+
</div>
14+
<div style="margin-top: 0; text-align: center; font-family: Arial, sans-serif; font-size: 12px; font-weight: normal">{label}</div>
15+
</div>
16+
</div>

‎src/components/BpmnGateway.astro‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
const { label, implemented } = Astro.props;
3+
---
4+
5+
<div style="display: flex; justify-content: center">
6+
<div>
7+
<div>
8+
<svg width="70" height="62">
9+
<g transform="translate(10, 6)">
10+
<slot />
11+
</g>
12+
</svg>
13+
</div>
14+
<div style="margin-top: 0; text-align: center; font-family: Arial, sans-serif; font-size: 12px; font-weight: normal">{label}</div>
15+
</div>
16+
</div>

‎src/components/BpmnTask.astro‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div style="display: flex; justify-content: center">
2+
<svg width="104" height="84">
3+
<g transform="translate(2, 2)">
4+
<slot />
5+
</g>
6+
</svg>
7+
</div>

‎src/components/Grid.astro‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
const { isContainer, sm, md, lg, children } = Astro.props;
3+
const containerClass = isContainer ? "grid-container" : "";
4+
const smClass = sm ? `col-${sm}` : "";
5+
const mdClass = md ? `col-md-${md}` : "";
6+
const lgClass = lg ? `col-lg-${lg}` : "";
7+
const classList = [containerClass, smClass, mdClass, lgClass].join(" ").trim();
8+
---
9+
10+
<style>
11+
.grid-container {
12+
display: grid;
13+
grid-template-columns: repeat(12, 1fr);
14+
gap: 16px;
15+
}
16+
17+
.col-1 {
18+
grid-column: span 1;
19+
}
20+
.col-2 {
21+
grid-column: span 2;
22+
}
23+
.col-3 {
24+
grid-column: span 3;
25+
}
26+
.col-4 {
27+
grid-column: span 4;
28+
}
29+
.col-5 {
30+
grid-column: span 5;
31+
}
32+
.col-6 {
33+
grid-column: span 6;
34+
}
35+
.col-7 {
36+
grid-column: span 7;
37+
}
38+
.col-8 {
39+
grid-column: span 8;
40+
}
41+
.col-9 {
42+
grid-column: span 9;
43+
}
44+
.col-10 {
45+
grid-column: span 10;
46+
}
47+
.col-11 {
48+
grid-column: span 11;
49+
}
50+
.col-12 {
51+
grid-column: span 12;
52+
}
53+
54+
@media (min-width: 768px) {
55+
.col-md-1 {
56+
grid-column: span 1;
57+
}
58+
.col-md-2 {
59+
grid-column: span 2;
60+
}
61+
.col-md-3 {
62+
grid-column: span 3;
63+
}
64+
.col-md-4 {
65+
grid-column: span 4;
66+
}
67+
.col-md-5 {
68+
grid-column: span 5;
69+
}
70+
.col-md-6 {
71+
grid-column: span 6;
72+
}
73+
.col-md-7 {
74+
grid-column: span 7;
75+
}
76+
.col-md-8 {
77+
grid-column: span 8;
78+
}
79+
.col-md-9 {
80+
grid-column: span 9;
81+
}
82+
.col-md-10 {
83+
grid-column: span 10;
84+
}
85+
.col-md-11 {
86+
grid-column: span 11;
87+
}
88+
.col-md-12 {
89+
grid-column: span 12;
90+
}
91+
}
92+
93+
@media (min-width: 1024px) {
94+
.col-lg-1 {
95+
grid-column: span 1;
96+
}
97+
.col-lg-2 {
98+
grid-column: span 2;
99+
}
100+
.col-lg-3 {
101+
grid-column: span 3;
102+
}
103+
.col-lg-4 {
104+
grid-column: span 4;
105+
}
106+
.col-lg-5 {
107+
grid-column: span 5;
108+
}
109+
.col-lg-6 {
110+
grid-column: span 6;
111+
}
112+
.col-lg-7 {
113+
grid-column: span 7;
114+
}
115+
.col-lg-8 {
116+
grid-column: span 8;
117+
}
118+
.col-lg-9 {
119+
grid-column: span 9;
120+
}
121+
.col-lg-10 {
122+
grid-column: span 10;
123+
}
124+
.col-lg-11 {
125+
grid-column: span 11;
126+
}
127+
.col-lg-12 {
128+
grid-column: span 12;
129+
}
130+
}
131+
</style>
132+
133+
<div class={classList} style="margin-top: 1rem">
134+
<slot />
135+
</div>

‎src/content.config.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { defineCollection } from 'astro:content';
2+
import { docsLoader } from '@astrojs/starlight/loaders';
3+
import { docsSchema } from '@astrojs/starlight/schema';
4+
5+
export const collections = {
6+
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
7+
};

0 commit comments

Comments
 (0)