Skip to content

QoL update: Explain how to preview HTML on different shells and introduce gitignore #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
javereec wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −0
Open

QoL update: Explain how to preview HTML on different shells and introduce gitignore #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# ignore markdown2rfc output
*.html
*.xml
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,22 @@ The current WG-Draft version is built automatically from the main branch and can

### Building the HTML

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:

**bash / zsh / sh**

```
cd 1.1
docker run -v `pwd`:/data danielfett/markdown2rfc openid-4-verifiable-presentations-1_1.md
```

**fish**

```
cd 1.1
docker run -v (pwd):/data danielfett/markdown2rfc openid-4-verifiable-presentations-1_1.md
```

### Conformance tests

Conformance tests are available for testing whether both Wallets and
Expand Down