Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
tyssejc committed Nov 17, 2022
0 parents commit 20d0d30
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: ci
on:
push:
branches:
- 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 mkdocs-material
- run: pip install mkdocs-git-revision-date-plugin
- run: mkdocs gh-deploy --force
27 changes: 27 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Node artifact files
node_modules/
dist/

# IDE
.vscode/

# Compiled Python bytecode
*.py[cod]

# Log files
*.log

# Generated by MacOS
.DS_Store

# Generated by Windows
Thumbs.db

# Large media files
*.mp4
*.tiff
*.avi
*.flv
*.mov
*.wmv

19 changes: 19 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
FROM python:3.10.0-alpine3.13

ARG WITH_PLUGINS=false

COPY requirements.txt requirements.txt
COPY requirements-plugins.txt requirements-plugins.txt

RUN pip install --no-cache-dir -r requirements.txt \
&& \
if [ "${WITH_PLUGINS}" = "true"]; then \
pip install --no-cache-dir -r requirements-plugins.txt; \
fi

WORKDIR /docs

EXPOSE 8080

ENTRYPOINT ["mkdocs"]
CMD ["serve"]
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# mkdocs-material

Based off of [afritzler/mkdocs-material](https://github.com/afritzler/mkdocs-material).

An opinionated arm64 build of [squidfunk/mkdocs-material](https://github.com/squidfunk/mkdocs-material) with PyMarkdown extensions and mkdocs plugins included.
3 changes: 3 additions & 0 deletions requirements-plugins.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
mkdocs-minify-plugin==0.6.1
mkdocs-redirects==1.2.0
mkdocs-git-revision-date-localized-plugin==1.1.0
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs-material==8.5.10

0 comments on commit 20d0d30

Please sign in to comment.