Skip to content

Commit

Permalink
doc: add Docker configuration for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
romm committed Oct 3, 2023
1 parent f4884cf commit 5445774
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 12 deletions.
4 changes: 2 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,8 @@
],
"doc": [
"Composer\\Config::disableProcessTimeout",
"pip install -r docs/requirements.txt",
"mkdocs serve --config-file docs/mkdocs.yml"
"docker build -t valinor-doc ./docs",
"docker run --name valinor-doc --rm -it -p 8000:8000 -v ${PWD}/docs:/docs valinor-doc"
]
},
"config": {
Expand Down
3 changes: 3 additions & 0 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
FROM squidfunk/mkdocs-material
COPY requirements.txt /tmp/requirements.txt
RUN pip install -r /tmp/requirements.txt
2 changes: 2 additions & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ theme:
- navigation.sections
- navigation.top
- navigation.indexes
- navigation.instant
- content.code.annotate
palette:
- media: "(prefers-color-scheme: light)"
Expand Down Expand Up @@ -97,3 +98,4 @@ nav:
- Alternatives: project/alternatives.md
- Changelog: project/changelog.md
- Credits: project/credits.md
not_in_nav: project/changelog/version-*.md
17 changes: 7 additions & 10 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
mkdocs==1.3.0
markdown==3.3.7
mkdocs-material==8.2.3
mkdocs==1.5.3
mkdocs-material==9.4.3
mkdocs-material-extensions==1.2

# Use mike=1.2.x when available
git+https://github.com/jimporter/mike@392d57b8bb9d14bcedf2451a0dc302709f8055eb
mike==1.1.2

# Markdown extensions
Pygments==2.12.0
pymdown-extensions==9.4

# MkDocs plugins
mkdocs-material-extensions==1.0.3
markdown==3.3.7
Pygments==2.16.1
pymdown-extensions==10.3

0 comments on commit 5445774

Please sign in to comment.