Skip to content

Commit f06771e

Browse files
committed
Explain how to preview HTML on different shells and introduce gitignore
Ignore the output from markdown2rfc to avoid checking it in
1 parent c39f50e commit f06771e

File tree

2 files changed

+14
-0
lines changed

2 files changed

+14
-0
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# ignore markdown2rfc output
2+
*.html
3+
*.xml

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,22 @@ The current WG-Draft version is built automatically from the main branch and can
99

1010
### Building the HTML
1111

12+
The easiest way to build the HTML is to use the [`danielfett/markdown2rfc`](https://hub.docker.com/r/danielfett/markdown2rfc) docker image. For example, to build the `1.1` version of the spec, do the following:
13+
14+
**bash / zsh / sh**
15+
1216
```
1317
cd 1.1
1418
docker run -v `pwd`:/data danielfett/markdown2rfc openid-4-verifiable-presentations-1_1.md
1519
```
1620

21+
**fish**
22+
23+
```
24+
cd 1.1
25+
docker run -v (pwd):/data danielfett/markdown2rfc openid-4-verifiable-presentations-1_1.md
26+
```
27+
1728
### Conformance tests
1829

1930
Conformance tests are available for testing whether both Wallets and

0 commit comments

Comments
 (0)