Skip to content
This repository has been archived by the owner on May 22, 2024. It is now read-only.

Commit

Permalink
add gh deploy action
Browse files Browse the repository at this point in the history
  • Loading branch information
SoumayaMauthoorMOJ committed Oct 8, 2022
1 parent b727d98 commit 55bdc90
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 5 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/gh-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: gh-deploy
on:
push:
branches:
- master
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- run: pip install -r requirements-doc.txt
- run: mkdocs gh-deploy --force
9 changes: 7 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,10 @@ Copy the template to create a new [repository](https://docs.github.com/en/reposi

Copy the following into the same location on your existing repository:

- `docs/assets` directory
- `docs/assets`
- `mkdocs.yml`
- `requirements-doc.txt`
- `requirements-doc.txt`
- `.github/workflows/gh-deploy.yml`

### Installation

Expand All @@ -56,6 +57,10 @@ MkDocs includes a live preview server, so you can preview your changes as you wr
mkdocs serve
```

### Publish

The Template uses [GitHub Actions](https://github.com/features/actions) to automate the deployment of your project documentation when a commit is pushed to either the master or main branches. See [publishing your site](https://squidfunk.github.io/mkdocs-material/publishing-your-site/) for more details.

## Contribute

👉 Find out how to [contribute](CONTRIBUTE.md).
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
site_name: Mkdocs GOV.UK Tech Docs Template
site_name: MkDocs GOV.UK Tech Docs Template
theme:
name: material
logo: assets/moj_logo.png
Expand All @@ -25,9 +25,9 @@ extra_css:
- assets/extra.css
copyright: "OGL: All content is available under the Open Government Licence v3.0, except where otherwise stated"
repo_url: https://github.com/ministryofjustice/mkdocs-tech-docs-template
edit_uri: edit/main/docs/
plugins:
- search
- monorepo
- git-revision-date-localized:
enable_creation_date: true
fallback_to_build_date: true
Expand Down
1 change: 0 additions & 1 deletion requirements-doc.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
mkdocs-material
mkdocs-git-revision-date-localized-plugin
mkdocs-monorepo-plugin

0 comments on commit 55bdc90

Please sign in to comment.