Skip to content
Closed
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
57 changes: 57 additions & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Deploy GitHub Pages

on:
push:
branches: ["main"]
paths:
- 'docs/**'
- '_config.yml'
- '.github/workflows/pages.yml'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1'
bundler-cache: true

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

- name: Build with Jekyll
run: |
bundle add jekyll jekyll-theme-minimal jekyll-relative-links jekyll-seo-tag jekyll-sitemap
bundle exec jekyll build --source . --destination ./_site
env:
JEKYLL_ENV: production

- name: Upload artifact
uses: actions/upload-pages-artifact@v3

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Binary file added docs/.jekyll-metadata
Binary file not shown.
Binary file removed docs/2021-10-12_Update-vLEI-IIW_v1.1_final.pdf
Binary file not shown.
7 changes: 7 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
source "https://rubygems.org"

gem "jekyll", "~> 4.3"
gem "minima", "~> 2.5"
gem "jekyll-feed"
gem "jekyll-seo-tag"
gem "webrick"
173 changes: 173 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
base64 (0.3.0)
bigdecimal (3.2.2)
colorator (1.1.0)
concurrent-ruby (1.3.5)
csv (3.3.5)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.17.2)
ffi (1.17.2-aarch64-linux-gnu)
ffi (1.17.2-aarch64-linux-musl)
ffi (1.17.2-arm-linux-gnu)
ffi (1.17.2-arm-linux-musl)
ffi (1.17.2-arm64-darwin)
ffi (1.17.2-x86-linux-gnu)
ffi (1.17.2-x86-linux-musl)
ffi (1.17.2-x86_64-darwin)
ffi (1.17.2-x86_64-linux-gnu)
ffi (1.17.2-x86_64-linux-musl)
forwardable-extended (2.6.0)
google-protobuf (4.32.0)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-aarch64-linux-gnu)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-aarch64-linux-musl)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-arm64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-x86-linux-gnu)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-x86-linux-musl)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-x86_64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-x86_64-linux-gnu)
bigdecimal
rake (>= 13)
google-protobuf (4.32.0-x86_64-linux-musl)
bigdecimal
rake (>= 13)
http_parser.rb (0.8.0)
i18n (1.14.7)
concurrent-ruby (~> 1.0)
jekyll (4.4.1)
addressable (~> 2.4)
base64 (~> 0.2)
colorator (~> 1.0)
csv (~> 3.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
json (~> 2.6)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.3, >= 0.3.6)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-feed (0.17.0)
jekyll (>= 3.7, < 5.0)
jekyll-sass-converter (3.1.0)
sass-embedded (~> 1.75)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
json (2.13.2)
kramdown (2.5.1)
rexml (>= 3.3.9)
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.9.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
minima (2.5.2)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (6.0.2)
rake (13.3.0)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.4.1)
rouge (4.6.0)
safe_yaml (1.0.5)
sass-embedded (1.90.0)
google-protobuf (~> 4.31)
rake (>= 13)
sass-embedded (1.90.0-aarch64-linux-android)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-aarch64-linux-gnu)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-aarch64-linux-musl)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-arm-linux-androideabi)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-arm-linux-gnueabihf)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-arm-linux-musleabihf)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-arm64-darwin)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-riscv64-linux-android)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-riscv64-linux-gnu)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-riscv64-linux-musl)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-x86_64-darwin)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-x86_64-linux-android)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-x86_64-linux-gnu)
google-protobuf (~> 4.31)
sass-embedded (1.90.0-x86_64-linux-musl)
google-protobuf (~> 4.31)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.6.0)
webrick (1.9.1)

PLATFORMS
aarch64-linux-android
aarch64-linux-gnu
aarch64-linux-musl
arm-linux-androideabi
arm-linux-gnu
arm-linux-gnueabihf
arm-linux-musl
arm-linux-musleabihf
arm64-darwin
riscv64-linux-android
riscv64-linux-gnu
riscv64-linux-musl
ruby
x86-linux-gnu
x86-linux-musl
x86_64-darwin
x86_64-linux-android
x86_64-linux-gnu
x86_64-linux-musl

DEPENDENCIES
jekyll (~> 4.3)
jekyll-feed
jekyll-seo-tag
minima (~> 2.5)
webrick

BUNDLED WITH
2.7.1
56 changes: 0 additions & 56 deletions docs/Schema_Registry.md

This file was deleted.

31 changes: 31 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
title: vLEI Ecosystem Credential Documentation
description: Documentation for the vLEI (verifiable Legal Entity Identifier) credential ecosystem implementation
theme: minima
baseurl: ""
url: ""

plugins:
- jekyll-feed
- jekyll-seo-tag

markdown: kramdown
kramdown:
syntax_highlighter: rouge
input: GFM

# Suppress Sass deprecation warnings
sass:
quiet_deps: true
verbose: false
style: compressed
sourcemap: never

# Additional settings to minimize output noise
quiet: true
incremental: true

header_pages:
- index.md
- credentials.md
- vlei-credential-ecosystem.md
- vlei-dependency-graph.md
52 changes: 52 additions & 0 deletions docs/_includes/head-custom.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<!-- Mermaid JS with ELK renderer -->
<script src="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/elkjs/lib/elk.bundled.js"></script>
<script>
document.addEventListener("DOMContentLoaded", function() {
mermaid.initialize({
startOnLoad: true,
theme: 'default',
themeVariables: {
primaryColor: '#f9f9f9',
primaryTextColor: '#333',
primaryBorderColor: '#ccc',
lineColor: '#333',
secondaryColor: '#f4f4f4',
tertiaryColor: '#fff'
},
elk: {
algorithm: "layered",
direction: "DOWN"
}
});

// Find all code blocks with mermaid language
document.querySelectorAll('pre code.language-mermaid').forEach(function(element) {
// Get the text content
var graphDefinition = element.textContent;

// Check if the diagram has ELK layout configuration and remove it
if (graphDefinition.includes('---') && graphDefinition.includes('layout: elk')) {
graphDefinition = graphDefinition.replace(/^---[\s\S]*?---\n/, '');
}

// Create a div to hold the rendered graph
var graphDiv = document.createElement('div');
graphDiv.className = 'mermaid';

// Add ELK directive for better layout, especially for class diagrams
var diagramType = graphDefinition.trim().split('\n')[0].toLowerCase();
if (diagramType.includes('classdiagram') || diagramType.includes('graph') || diagramType.includes('flowchart')) {
graphDefinition = '%%{init: {"elk": {"algorithm": "layered", "direction": "DOWN", "spacing": {"nodeNode": 50}}, "theme": "default"}}%%\n' + graphDefinition;
}

graphDiv.textContent = graphDefinition;

// Replace the pre element with the new div
element.closest('pre').replaceWith(graphDiv);
});

// Re-initialize mermaid to render the new divs
mermaid.init();
});
</script>
Loading