{"id":19901926,"url":"https://github.com/hyperledger-identus/docs","last_synced_at":"2025-05-02T23:32:08.147Z","repository":{"id":227112816,"uuid":"588124318","full_name":"hyperledger-identus/docs","owner":"hyperledger-identus","description":"Documentation website for the Identus Platform","archived":false,"fork":false,"pushed_at":"2025-04-27T00:34:10.000Z","size":154983,"stargazers_count":11,"open_issues_count":22,"forks_count":4,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-04-27T01:26:18.813Z","etag":null,"topics":["did","didcomm","didcomm-v2","didprism","docs","identus","ssi"],"latest_commit_sha":null,"homepage":"https://hyperledger-identus.github.io/docs/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyperledger-identus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-01-12T11:38:31.000Z","updated_at":"2025-04-27T00:30:44.000Z","dependencies_parsed_at":"2024-03-31T01:24:46.241Z","dependency_job_id":"6566351f-2ac6-421a-ab6c-715bc37596e0","html_url":"https://github.com/hyperledger-identus/docs","commit_stats":null,"previous_names":["input-output-hk/atala-prism-docs","hyperledger/identus-docs","hyperledger-identus/docs"],"tags_count":176,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyperledger-identus%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyperledger-identus","download_url":"https://codeload.github.com/hyperledger-identus/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252122303,"owners_count":21698305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["did","didcomm","didcomm-v2","didprism","docs","identus","ssi"],"created_at":"2024-11-12T20:16:38.736Z","updated_at":"2025-05-02T23:32:08.140Z","avatar_url":"https://github.com/hyperledger-identus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Identus documentation website\n\nThis website is built using [Docusaurus 2](https://docusaurus.io/).\n\n# Structure\n* docs\n* tutorials\n* sdk\n* api\n\n## `docs`: general documentation\n* Getting started guides\n* SSI and Identus concepts\n* Identus architecture and components description\n\n## `tutorials`: general Identus tutorials\n* Credential issuance\n* Verification\n* DIDs\n* etc.\n\n## `sdk`: SDKs documentation\n* sdk-ts\n* sdk-swift\n* sdk-kmp\n\n## `api`: autogenerated docs from OpenAPI specs\n`documentation/api` directory contains auto-generated documentation for RestAPI endpoints provided by Identus executables, it's auto-generated and should not be added manually.\n\n## Installation\n\nHere are the simple installation instructions for MacOS to start from the very scratch.\n\n```shell\n# Install brew, git, node and yarn\n# If you have these tools, skip these steps\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)\"\nbrew install git\nbrew install node\nbrew install yarn\n\n# Create new projects directory\ncd ~ \u0026\u0026 mkdir projects \u0026\u0026 cd projects\ngit clone https://github.com/hyperledger-identus/docs.git\n# Initialize submodules\ngit submodule init\n# Update submodules\ngit submodule update --remote --recursive\n\n# Use this step to checkout custom branch to review from PR\n# git checkout feature-branch\n\n# Deploy local version of the website\ncd docs\nyarn install\nyarn start\n```\n\n## Local Development\n\n```\n$ yarn start\n```\n\nThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.\n\n## Build\n\n```\n$ yarn build --out-dir infra/website\n```\n\nThis command creates a set of static resources which can be hosted to serve the full site.\n\n## Run [linkinator](https://github.com/JustinBeckwith/linkinator) locally to check the broken links of the live website\n\n```shell\n$ npx linkinator https://hyperledger-identus.github.io/docs/ --config .linkinatorrc.json --format text\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger-identus%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyperledger-identus%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyperledger-identus%2Fdocs/lists"}