Browse Source

add init version of docs

master
Charles Reid 4 years ago
parent
commit
d5adf48aa5
  1. 3
      .gitmodules
  2. 18
      docs/index.md
  3. 1
      mkdocs-material
  4. 20
      mkdocs.yml

3
.gitmodules

@ -0,0 +1,3 @@
[submodule "mkdocs-material"]
path = mkdocs-material
url = https://git.charlesreid1.com/charlesreid1/mkdocs-material.git

18
docs/index.md

@ -0,0 +1,18 @@
# d-python-files
simple lightweight python files server.
```
python3 -m http.simple -b 127.0.0.1 -p 8081
```
This listens for local requests on port 8081.
This service is reverse-proxied by nginx.
Users send requests to `files.charlesreid1.X/file`
and they are rewritten on the backend to
`127.0.0.1:8081/file`.
This uses `jfloff/alpine-python:recent`
(see [jflof/alpine-python](https://github.com/jfloff/alpine-python)).

1
mkdocs-material

@ -0,0 +1 @@
Subproject commit ff95dcb8463eb5f8f65b14c3d145afae21671ad9

20
mkdocs.yml

@ -0,0 +1,20 @@
site_name: d-python-files
docs_dir: docs
site_dir: site
extra_css:
- css/custom.css
theme:
name: null
custom_dir: 'mkdocs-material/material'
palette:
primary: 'light green'
accent: 'light green'
logo:
icon: 'input'
font:
text: 'Roboto'
code: 'Roboto Mono'
markdown_extensions:
- admonition
pages:
- 'Home': 'index.md'
Loading…
Cancel
Save