Skip to content

Commit 41ec091

Browse files
authored
Update snippets to use console type for snippets
`shell` or `bash` expects the entire snippet to be a bash script, while `console` highlights only lines prefixed with `$` as bash.
1 parent 11edfab commit 41ec091

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

types.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This documentation contains information on how to sign and upload data in differ
66

77
Create a keypair with something like:
88

9-
```shell
9+
```console
1010
$ minisign -G
1111
Please enter a password to protect the secret key.
1212

@@ -24,23 +24,23 @@ minisign -Vm <file> -P RWSzQI7+S6M0c4yReOwcDZ2petL8pAZsrNfkdyqr0V7j/HGafpjdKZQm
2424

2525
Sign a file:
2626

27-
```shell
27+
```console
2828
$ minisign -S -m README.md
2929
Password:
3030
Deriving a key from the password and decrypting the secret key... done
3131
```
3232

3333
Upload to rekor:
3434

35-
```shell
35+
```console
3636
$ rekor-cli upload --artifact README.md --signature README.md.minisig --pki-format=minisign --public-key=minisign.pub
3737
Created entry at index 5895, available at: https://rekor.sigstore.dev/api/v1/log/entries/008bfbbaa8f473a0b17cba5f8078d2c08410bca55f01d2ec71860795ef823b36
3838
```
3939

4040
Look at the entry with:
4141

42-
```shell
43-
$ ./rekor-cli get --uuid=008bfbbaa8f473a0b17cba5f8078d2c08410bca55f01d2ec71860795ef823b36
42+
```console
43+
$ ./rekor-cli get --uuid=008bfbbaa8f473a0b17cba5f8078d2c08410bca55f01d2ec71860795ef823b36
4444
LogID: c0d23d6ad406973f9559f3ba2d1ca01f84147d8ffc5b8445c224f98b9591801d
4545
Index: 5895
4646
IntegratedTime: 2021-07-14T01:39:50Z
@@ -68,8 +68,8 @@ Body: {
6868

6969
Generate a keypair with:
7070

71-
```shell
72-
ssh-keygen -C test@rekor.dev -t ed25519 -f id_ed25519
71+
```console
72+
$ ssh-keygen -C test@rekor.dev -t ed25519 -f id_ed25519
7373
Generating public/private ed25519 key pair.
7474
Enter passphrase (empty for no passphrase):
7575
Enter same passphrase again:
@@ -93,7 +93,7 @@ The key's randomart image is:
9393

9494
Sign a file with:
9595

96-
```shell
96+
```console
9797
$ ssh-keygen -Y sign -n file -f id_ed25519 README.md
9898
Enter passphrase:
9999
Signing file README.md
@@ -102,14 +102,14 @@ Write signature to README.md.sig
102102

103103
Upload it to rekor with:
104104

105-
```shell
105+
```console
106106
$ rekor-cli upload --artifact README.md --signature README.md.sig --pki-format=ssh --public-key=id_ed25519.pub
107107
Created entry at index 5896, available at: https://rekor.sigstore.dev/api/v1/log/entries/0e81b4d9299e2609e45b5c453a4c0e7820ac74e02c4935a8b830d104632fd2d
108108
```
109109

110110
Look at the entry with:
111111

112-
```shell
112+
```console
113113
$ rekor-cli get --uuid=0e81b4d9299e2609e45b5c453a4c0e7820ac74e02c4935a8b830d104632fd2d1
114114
LogID: c0d23d6ad406973f9559f3ba2d1ca01f84147d8ffc5b8445c224f98b9591801d
115115
Index: 5896
@@ -138,7 +138,7 @@ Body: {
138138

139139
Generate a keypair with:
140140

141-
```shell
141+
```console
142142
$ openssl ecparam -genkey -name prime256v1 > ec_private.pem
143143
$ openssl ec -in ec_private.pem -pubout > ec_public.pem
144144
read EC key
@@ -147,20 +147,20 @@ writing EC key
147147

148148
Sign the file with:
149149

150-
```shell
150+
```console
151151
$ openssl dgst -sha256 -sign ec_private.pem -out README.md.sig README.md
152152
```
153153

154154
Upload it to rekor with:
155155

156-
```shell
156+
```console
157157
$ ./rekor-cli upload --artifact README.md --signature README.md.sig --pki-format=x509 --public-key=ec_public.pem
158158
Created entry at index 5897, available at: https://rekor.sigstore.dev/api/v1/log/entries/31a51c1bc20da83b66b2f24899184b85dbf8261c2de8571479165619ad87cd5d
159159
```
160160

161161
View the entry with:
162162

163-
```shell
163+
```console
164164
$ rekor-cli get --uuid=31a51c1bc20da83b66b2f24899184b85dbf8261c2de8571479165619ad87cd5d
165165
LogID: c0d23d6ad406973f9559f3ba2d1ca01f84147d8ffc5b8445c224f98b9591801d
166166
Index: 5897
@@ -201,4 +201,4 @@ TODO
201201

202202
TODO
203203

204-
## TSR
204+
## TSR

0 commit comments

Comments
 (0)