Skip to content

Commit

Permalink
Add some bells and whistles around the docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
pklaschka committed Dec 15, 2023
1 parent 1aa4d8a commit 8fb5ebf
Show file tree
Hide file tree
Showing 5 changed files with 23 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ jobs:
steps:
- name: Checkout main
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v2
with:
Expand Down
6 changes: 5 additions & 1 deletion docs/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@ FROM squidfunk/mkdocs-material:9
MAINTAINER "WüSpace e.V."

# Install mkdocs plugins from requirements.txt
COPY requirements.txt /docs/requirements.txt
COPY docs/requirements.txt /docs/requirements.txt
RUN pip install -r /docs/requirements.txt

# Copy .git to /docs/.git
COPY .git /.git

WORKDIR /docs
STOPSIGNAL SIGKILL
ENTRYPOINT ["mkdocs"]
CMD ["serve", "--dev-addr=0.0.0.0:4044"]
4 changes: 2 additions & 2 deletions docs/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ services:
volumes:
- .:/docs
build:
context: .
dockerfile: Dockerfile
context: ../
dockerfile: docs/Dockerfile
args:
DOCKER_BUILDKIT: 1
13 changes: 13 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,15 @@
site_name: Telestion Documentation

repo_url: https://github.com/wuespace/telestion
repo_name: wuespace/telestion
edit_uri: edit/main/docs/docs/
copyright: |
<p>
&copy; 2023 WüSpace e. V.
<p>
<a href="https://www.wuespace.de/legal-notice/" target="_blank">Legal Notice</a>
| <a href="https://www.wuespace.de/privacy-policy/" target="_blank">Privacy Policy</a>
</p>
theme:
name: material
Expand Down Expand Up @@ -32,6 +40,8 @@ theme:
- content.code.copy
- content.code.annotate
- content.action.edit
- content.action.view
- search.highlight

extra_css:
- _css/custom.css
Expand Down Expand Up @@ -70,7 +80,10 @@ plugins:
- awesome-pages
- tags
- search
- social
- privacy
- git-revision-date-localized:
enable_creation_date: true

extra:
social:
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ mkdocs==1.5.3
mkdocs-awesome-pages-plugin==2.9.2
mkdocs-material==9.5.2
mkdocs-material-extensions==1.3.1
mkdocs-git-revision-date-localized-plugin==1.2.1

0 comments on commit 8fb5ebf

Please sign in to comment.