# identus-docs

**Repository Path**: mirrors_hyperledger/identus-docs

## Basic Information

- **Project Name**: identus-docs
- **Description**: Documentation website for the Identus Platform
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-04
- **Last Updated**: 2025-09-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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
```