Skip to content

Commit

Permalink
fix: Candid file rendering in spec (#2543)
Browse files Browse the repository at this point in the history 
Update and rename ii-spec.md to ii-spec.mdx
  • Loading branch information
@jessiemongeon1
jessiemongeon1 authored Jul 18, 2024
1 parent 402d6ea commit 43310e6
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions docs/ii-spec.md → docs/ii-spec.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import CodeBlock from "@theme/CodeBlock";
import IICandidInterface from "!!raw-loader!../src/internet_identity/internet_identity.did";

# The Internet Identity Specification

## Introduction
Expand Down Expand Up @@ -291,11 +294,7 @@ This interface is currently only used by its own frontend. This tight coupling m

The summary is given by the Candid interface:

<!-- The '_attachments/` bit is an implementation detail of the docusaurus deploy -->

``` candid name=https://raw.githubusercontent.com/dfinity/internet-identity/main/src/internet_identity/internet_identity.did
```

<CodeBlock language="candid">{IICandidInterface}</CodeBlock>

The `init_salt` method is mostly internal, see [Salt](#salt).

Expand Down

3 comments on commit 43310e6

@timk11
Copy link

@timk11 timk11 commented on 43310e6 Aug 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new sections don't seem to render properly. On my device they just appear as plain text like so:

image

@frederikrothenberger
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@timk11: The change was made so that it correctly renders here which is the intended place to view that documentation.

@timk11
Copy link

@timk11 timk11 commented on 43310e6 Aug 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fantastic. Thanks for pointing that out!

Please sign in to comment.