diff --git a/.github/workflows/deploy-pages.yml b/.github/workflows/deploy-pages.yml new file mode 100644 index 0000000..2419a85 --- /dev/null +++ b/.github/workflows/deploy-pages.yml @@ -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 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 318044e..0f8b44d 100644 --- a/.gitignore +++ b/.gitignore @@ -319,3 +319,4 @@ cython_debug/ /cache-directory/ data .vscode +node_modules diff --git a/docs/installation.md b/docs/installation.md index fc43b30..a4878db 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index a1ebf4d..8152e71 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,5 +9,6 @@ theme: readthedocs plugins: - search - mermaid2 + - likec4 markdown_extensions: - admonition diff --git a/package.json b/package.json new file mode 100644 index 0000000..a847785 --- /dev/null +++ b/package.json @@ -0,0 +1,5 @@ +{ + "dependencies": { + "likec4": "^1.59.2" + } +}