Skip to content

Commit 713409e

Browse files
laurensdebebremer
andauthored
feat(vocab): setup yml2vocab for managing the LWS vocabulary and json-ld context (#112)
* feat(vocab): initialize lws10-vocab with yml2vocab dependency * feat(vocab): add LWS vocabulary definition * feat(vocab): add HTML template for vocabulary document * feat(vocab): add generated vocabulary artifacts Generated by yml2vocab from vocabulary.yml and template.html: vocabulary.html, vocabulary.ttl, vocabulary.jsonld, vocabulary.context.jsonld * ci: add GitHub Actions workflow to build LWS vocabulary * rename vocabulary.html to index.html in build output * fix: minor improvements * fix: remove id prefix in vocabulary.yml * chore: add affiliation for editors and authors Added company and companyURL fields for editors and authors. * Add 'updated' and 'size' properties to vocabulary Added new properties for 'updated' and 'size' in vocabulary. * Create README.md for LWS Vocabulary Added README.md with information about LWS Vocabulary. * ci: replace build-vocab with GitHub Pages deployment workflow - Deploy entire repo to GitHub Pages instead of committing generated files - Remove generated vocab artifacts from git tracking - Update lws10-vocab/.gitignore to exclude generated files * chore: fix affiliation details --------- Co-authored-by: Erich Bremer <erich@ebremer.com>
1 parent d8a4de3 commit 713409e

7 files changed

Lines changed: 1754 additions & 0 deletions

File tree

.github/workflows/build-deploy.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: false
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
22+
- uses: actions/setup-node@v4
23+
with:
24+
node-version: "20"
25+
cache: "npm"
26+
cache-dependency-path: lws10-vocab/package-lock.json
27+
28+
- name: Build vocabulary
29+
working-directory: lws10-vocab
30+
run: |
31+
npm ci
32+
npm run build
33+
34+
- uses: actions/upload-pages-artifact@v3
35+
with:
36+
path: .
37+
38+
deploy:
39+
runs-on: ubuntu-latest
40+
needs: build
41+
environment:
42+
name: github-pages
43+
url: ${{ steps.deployment.outputs.page_url }}
44+
steps:
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

lws10-vocab/.gitignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
index.html
3+
vocabulary.ttl
4+
vocabulary.jsonld
5+
vocabulary.context.jsonld

lws10-vocab/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# LWS Vocabulary
2+
3+
This directory contains the source definition for the **Linked Web Storage (LWS) Vocabulary**.
4+
5+
## Files
6+
7+
### Source files (edit these)
8+
- `vocabulary.yml` — Main vocabulary definition
9+
- `template.html` — HTML template for documentation
10+
11+
### Generated files (do not edit directly)
12+
- `index.html` — Human-readable HTML documentation
13+
- `vocabulary.ttl` — RDF/Turtle serialization
14+
- `vocabulary.jsonld` — Full JSON-LD serialization
15+
- `vocabulary.context.jsonld` — JSON-LD Context file
16+
17+
## How to regenerate locally
18+
19+
```bash
20+
cd lws10-vocab
21+
npx yml2vocab

0 commit comments

Comments
 (0)