Skip to content

Commit 87d1349

Browse files
committed
docs: add mkdocs gh-deploy info
1 parent c953ba0 commit 87d1349

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

Diff for: README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It covers:
1313
1. Day 2 deployment information for [automating packaging](https://grokify.github.io/fastly-guide-compute/compute/packaging/)
1414
2. Day 2 deployment information for [API and SDK upload and activation options](https://grokify.github.io/fastly-guide-compute/compute/uploading_and_activation/)
1515

16-
## Running the Guide Locally
16+
## Running the Guide Locally (for authors)
1717

1818
This Developer Guide is built on top of Mkdocs, a self-contained documentation server. Writers are encouraged to install Mkdocs locally so that you can edit files and preview your changes before they are pushed to production servers.
1919

@@ -25,4 +25,12 @@ pip install --upgrade mkdocs-material
2525
mkdocs serve
2626
```
2727

28-
Then you should be able to load http://localhost:8000 to view the documentation.
28+
Then you should be able to load http://localhost:8000 to view the documentation.
29+
30+
## Deploying the Guide
31+
32+
Once the updates have been made, use the following command to publish to GitHub pages:
33+
34+
```bash
35+
mkdocs gh-deploy
36+
```

0 commit comments

Comments
 (0)