You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-1Lines changed: 13 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -22,11 +22,23 @@ You can open this repo on GitHub to read, use the GitHub Pages for a published v
22
22
For example, it is easy to use `.` to start the GitHub Web Editor to read and edit these files.
23
23
24
24
25
-
## Build instructions
25
+
###Build using container
26
26
To create the HTML output, you can use:
27
27
28
28
```
29
29
$ podman run --rm -v $PWD:/workspace quay.io/crc-org/mdbook:0.4.43 build
30
30
```
31
31
32
32
This will create a `book` folder that contains the output for a static webpage like GitHub Pages.
33
+
34
+
35
+
### Devcontainer
36
+
You can also use the devcontainer setup. This will start the generation container and allows you to use the `mdbook` command line directly from inside the editor.
37
+
38
+
This can be started from CodeSpaces, VS Code or the CLI
39
+
```shell
40
+
$ npm install -g @devcontainers/cli
41
+
$ devcontainer up --workspace-folder .
42
+
```
43
+
44
+
After the container has been started, you can use `mdbook build` to generate the output, and `mdbook serve` to open a preview using the forward of port 3000.
0 commit comments