https://github.com/hyperledger-identus/docs
Documentation website for the Identus Platform
https://github.com/hyperledger-identus/docs
did didcomm didcomm-v2 didprism docs identus ssi
Last synced: about 1 month ago
JSON representation
Documentation website for the Identus Platform
- Host: GitHub
- URL: https://github.com/hyperledger-identus/docs
- Owner: hyperledger-identus
- License: apache-2.0
- Created: 2023-01-12T11:38:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-27T00:34:10.000Z (about 1 month ago)
- Last Synced: 2025-04-27T01:26:18.813Z (about 1 month ago)
- Topics: did, didcomm, didcomm-v2, didprism, docs, identus, ssi
- Language: JavaScript
- Homepage: https://hyperledger-identus.github.io/docs/
- Size: 148 MB
- Stars: 11
- Watchers: 14
- Forks: 4
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Identus documentation website
This website is built using [Docusaurus 2](https://docusaurus.io/).
# Structure
* docs
* tutorials
* sdk
* api
## `docs`: general documentation
* Getting started guides
* SSI and Identus concepts
* Identus architecture and components description
## `tutorials`: general Identus tutorials
* Credential issuance
* Verification
* DIDs
* etc.
## `sdk`: SDKs documentation
* sdk-ts
* sdk-swift
* sdk-kmp
## `api`: autogenerated docs from OpenAPI specs
`documentation/api` directory contains auto-generated documentation for RestAPI endpoints provided by Identus executables, it's auto-generated and should not be added manually.
## Installation
Here are the simple installation instructions for MacOS to start from the very scratch.
```shell
# Install brew, git, node and yarn
# If you have these tools, skip these steps
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install git
brew install node
brew install yarn
# Create new projects directory
cd ~ && mkdir projects && cd projects
git clone https://github.com/hyperledger-identus/docs.git
# Initialize submodules
git submodule init
# Update submodules
git submodule update --remote --recursive
# Use this step to checkout custom branch to review from PR
# git checkout feature-branch
# Deploy local version of the website
cd docs
yarn install
yarn start
```
## Local Development
```
$ yarn start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
## Build
```
$ yarn build --out-dir infra/website
```
This command creates a set of static resources which can be hosted to serve the full site.
## Run [linkinator](https://github.com/JustinBeckwith/linkinator) locally to check the broken links of the live website
```shell
$ npx linkinator https://hyperledger-identus.github.io/docs/ --config .linkinatorrc.json --format text
```