Skip to content

Commit 4b3cf8e

Browse files
authored
Merge pull request #78 from CiscoDevNet/readme-preview
Add preview section
2 parents 41f4139 + f845139 commit 4b3cf8e

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,22 @@ These Learning Labs are for building your home networking lab for network progra
1616

1717
If you need more help, reach out to DevNet through one of our [support options](https://developer.cisco.com/site/devnet/support/).
1818

19+
## Preview Learning Lab Markdown locally
20+
21+
You can preview how the Markdown renders by using a pre-built Docker image. The `Makefile` in the root of the repository lets you run `make preview` to view the output HTML.
22+
23+
1. Make sure you have Docker installed locally. If not, [install Docker](https://docs.docker.com/install/) for your operating system.
24+
```
25+
$ docker -v
26+
```
27+
1. In the root of the repository, run:
28+
```
29+
$ make preview
30+
```
31+
1. Open a browser window with the URL: `http://localhost:9000`.
32+
1. Click a folder to find the Markdown file you want to preview.
33+
1. When you are done previewing, type `Ctrl+C` to stop running the Docker container.
34+
1935
## Contributing
2036

2137
These learning modules are for public consumption, so you must ensure that you have the rights to any content that you contribute.

0 commit comments

Comments
 (0)