Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
# Sample workflow for building and deploying a website to GitHub Pages
name: Deploy Pages

on:
# Runs on pushes targeting the default branch and c4 files
pull_request:

# Allows you to run this workflow manually from the Actions tab
workflow_call:
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
#permissions:
# contents: read
# pages: write
# id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in progress and the latest queued.
# However, do NOT cancel in-progress runs, as we want to allow these production deployments to be completed.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Validate model following our rules
# @see test/validate-model.spec.ts
validate:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v5

- name: Setup bun
uses: oven-sh/setup-bun@v2

- name: Install dependencies
run: bun install

#- name: Validate
# run: bun run test

# Build job
build-pages:
runs-on: ubuntu-latest
needs: validate
steps:
- name: Checkout
uses: actions/checkout@v5

- name: Setup bun
uses: oven-sh/setup-bun@v2

- name: Setup Pages
id: pages
uses: actions/configure-pages@v4

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./dist

- name: Build
run: |
bunx likec4@latest build \
--base "${{ steps.pages.outputs.base_path || '/docs' }}" \
--output dist

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./dist

# Deployment job
#deploy-pages:
# environment:
# name: github-pages
# url: ${{ steps.deployment.outputs.page_url }}
# runs-on: ubuntu-latest
# needs: build-pages
# steps:
# - name: Deploy to GitHub Pages
# id: deployment
# uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -319,3 +319,4 @@ cython_debug/
/cache-directory/
data
.vscode
node_modules
5 changes: 5 additions & 0 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Installation & Setup

```likec4-view
ro-crate_service
```

## Service Snapshot
The RO-Crate Validation Service works in two ways: a metadata-only mode, in which the contents of an `ro-crate-metadata.json` file are assessed, and storage-backed validation, where complete RO-Crates (zip or directory) are evaluated.

## Quick start
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ theme: readthedocs
plugins:
- search
- mermaid2
- likec4
markdown_extensions:
- admonition
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"likec4": "^1.59.2"
}
}
Loading