mirror of
https://github.com/thegeeklab/corenetworks.git
synced 2024-11-21 21:20:38 +00:00
add minimal documentation
This commit is contained in:
parent
3187862524
commit
caa8e705ee
17
README.md
17
README.md
@ -1,3 +1,20 @@
|
||||
# corenetworks
|
||||
|
||||
[![Build Status](https://img.shields.io/drone/build/xoxys/corenetworks?logo=drone)](https://cloud.drone.io/xoxys/corenetworks)
|
||||
[![Python Version](https://img.shields.io/pypi/pyversions/corenetworks.svg)](https://pypi.org/project/corenetworks/)
|
||||
[![PyPi Status](https://img.shields.io/pypi/status/corenetworks.svg)](https://pypi.org/project/corenetworks/)
|
||||
[![PyPi Release](https://img.shields.io/pypi/v/corenetworks.svg)](https://pypi.org/project/corenetworks/)
|
||||
[![Codecov](https://img.shields.io/codecov/c/github/xoxys/corenetworks)](https://codecov.io/gh/xoxys/corenetworks)
|
||||
[![License: MIT](https://img.shields.io/github/license/xoxys/corenetworks)](LICENSE)
|
||||
|
||||
Python library for the [https://core-networks.de](https://beta.api.core-networks.de/doc/) DNS API.
|
||||
|
||||
You can find the full documentation at [https://corenetworks.geekdocs.de](https://corenetworks.geekdocs.de/).
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Maintainers and Contributors
|
||||
|
||||
[Robert Kaussow](https://github.com/xoxys)
|
||||
|
31
corenetworks/docs/config.yaml
Normal file
31
corenetworks/docs/config.yaml
Normal file
@ -0,0 +1,31 @@
|
||||
---
|
||||
baseURL: https://corenetworks.geekdocs.de/
|
||||
title: corenetworks
|
||||
theme: hugo-geekdoc
|
||||
pygmentsUseClasses: true
|
||||
pygmentsCodeFences: true
|
||||
|
||||
# Geekdoc configuration
|
||||
disablePathToLower: true
|
||||
enableGitInfo: true
|
||||
|
||||
# Needed for mermaid/katex shortcodes
|
||||
markup:
|
||||
goldmark:
|
||||
renderer:
|
||||
unsafe: true
|
||||
tableOfContents:
|
||||
startLevel: 1
|
||||
|
||||
params:
|
||||
geekdocMenuBundle: true
|
||||
geekdocToC: 3
|
||||
|
||||
geekdocRepo: https://github.com/xoxys/corenetworks
|
||||
geekdocEditPath: edit/master/docs/content
|
||||
|
||||
geekdocDateFormat: "Jan 2, 2006"
|
||||
geekdocSearch: true
|
||||
|
||||
geekdocLegalNotice: https://geeklabor.de/legal-notice/#impressum
|
||||
geekdocPrivacyPolicy: https://geeklabor.de/legal-notice/#datenschutzerkl%C3%A4rung
|
6
corenetworks/docs/data/menu/main.yml
Normal file
6
corenetworks/docs/data/menu/main.yml
Normal file
@ -0,0 +1,6 @@
|
||||
---
|
||||
main:
|
||||
- name: Setup
|
||||
ref: "/setup"
|
||||
- name: Usage
|
||||
ref: "/usage"
|
10
corenetworks/docs/data/menu/more.yml
Normal file
10
corenetworks/docs/data/menu/more.yml
Normal file
@ -0,0 +1,10 @@
|
||||
---
|
||||
more:
|
||||
- name: Releases
|
||||
ref: "https://github.com/xoxys/corenetworks/releases"
|
||||
external: true
|
||||
icon: "download"
|
||||
- name: "View Source"
|
||||
ref: "https://github.com/xoxys/corenetworks"
|
||||
external: true
|
||||
icon: "github"
|
16
corenetworks/docs/static/.htaccess
vendored
Normal file
16
corenetworks/docs/static/.htaccess
vendored
Normal file
@ -0,0 +1,16 @@
|
||||
ErrorDocument 404 /404.html
|
||||
|
||||
ExpiresActive On
|
||||
ExpiresDefault "access plus 600 seconds"
|
||||
ExpiresByType text/css "access plus 1 week"
|
||||
ExpiresByType text/javascript "access plus 1 month"
|
||||
ExpiresByType text/html "access plus 1 seconds"
|
||||
ExpiresByType application/javascript "access plus 1 month"
|
||||
ExpiresByType application/x-javascript "access plus 1 month"
|
||||
ExpiresByType image/gif "access plus 1 week"
|
||||
ExpiresByType image/jpeg "access plus 1 week"
|
||||
ExpiresByType image/png "access plus 1 week"
|
||||
ExpiresByType image/x-icon "access plus 1 month"
|
||||
ExpiresByType image/svg+xml "access plus 1 week"
|
||||
ExpiresByType application/x-font-woff "access plus 1 week"
|
||||
ExpiresByType application/font-woff2 "access plus 1 week"
|
12
corenetworks/docs/static/_index.md
vendored
Normal file
12
corenetworks/docs/static/_index.md
vendored
Normal file
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: Documentation
|
||||
---
|
||||
|
||||
[![Build Status](https://img.shields.io/drone/build/xoxys/corenetworks?logo=drone)](https://cloud.drone.io/xoxys/corenetworks/)
|
||||
[![Python Version](https://img.shields.io/pypi/pyversions/corenetworks.svg)](https://pypi.org/project/corenetworks/)
|
||||
[![PyPi Status](https://img.shields.io/pypi/status/corenetworks.svg)](https://pypi.org/project/corenetworks/)
|
||||
[![PyPi Release](https://img.shields.io/pypi/v/corenetworks.svg)](https://pypi.org/project/corenetworks/)
|
||||
[![Codecov](https://img.shields.io/codecov/c/github/xoxys/corenetworks)](https://codecov.io/gh/xoxys/corenetworks)
|
||||
[![License: MIT](https://img.shields.io/github/license/xoxys/corenetworks)](LICENSE)
|
||||
|
||||
Python library for the [https://core-networks.de](https://beta.api.core-networks.de/doc/) DNS API.
|
Loading…
Reference in New Issue
Block a user