1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
site_name: PyFunceble
theme:
name: material
palette:
# Palette toggle for dark mode
- scheme: slate
primary: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
# Palette toggle for light mode
- scheme: default
primary: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
features:
- navigation.footer
- content.action.edit
- content.code.copy
- navigation.tabs
- content.code.annotate
icon:
repo: fontawesome/brands/github
# TOOD: Switch to main branch.
edit_uri: edit/switch-to-mkdocs/docs/
extra:
social:
- icon: fontawesome/brands/twitter
link: https://twitter.com/pyfunceble
- icon: fontawesome/brands/docker
link: https://hub.docker.com/u/pyfunceble
- icon: fontawesome/brands/github
link: https://github.com/funilrys/PyFunceble
- icon: fontawesome/brands/github
link: https://github.com/PyFunceble
copyright: |
Copyright © 2017 - 2024 <b>Nissar Chababy <i>(@funilrys)</i> & PyFunceble Contributors</b>
markdown_extensions:
- admonition
- pymdownx.highlight:
anchor_linenums: yes
line_spans: __span
pygments_lang_class: yes
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: yes
- footnotes
- tables
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
plugins:
- search
- offline:
enabled: true
- autorefs
- mkdocstrings:
default_handler: python
handlers:
python:
options:
docstring_style: sphinx
- gen-files:
scripts:
- docs/gen_ref_pages.py
- literate-nav:
nav_file: SUMMARY.md
- section-index
repo_name: funilrys/PyFunceble
repo_url: https://github.com/funilrys/PyFunceble
nav:
- Home:
- index.md
- Installation: use/installation.md
- Update: use/update.md
- User Guides:
- use/index.md
- Installation: use/installation.md
- Update: use/update.md
- Getting Started: use/getting-started.md
- Examples:
- Availability Check: use/examples/availability.md
- Syntax Check: use/examples/syntax.md
- Configuration:
- use/configuration/index.md
- Location: use/configuration/location.md
- Environment Variables: use/configuration/environment-variables.md
- Parameters: use/configuration/parameters/
- CI/CD:
- GitHub Actions: use/ci-cd/github-actions.md
- GitLab CI/CD: use/ci-cd/gitlab-ci-cd.md
- Travis CI: use/ci-cd/travis-ci.md
- FAQ: use/faq.md
- Known Issues: use/known-issues.md
- Developer Guides:
- Getting Started: develop/getting-started.md
- Checker Responses: develop/checker-responses.md
- Examples:
- Domain Availability: develop/examples/domain-availability.md
- Domain Syntax: develop/examples/domain-syntax.md
- Domain & IP Availability: develop/examples/domain-ip-availability.md
- IP Availability: develop/examples/ip-availability.md
- IP Syntax: develop/examples/ip-syntax.md
- URL Availability: develop/examples/url-availability.md
- URL Syntax: develop/examples/url-syntax.md
- File Generation: develop/examples/file-generation.md
- Code References: develop/api-references/index.md
- Contribution Guides:
- Contributing: contributing/contributing.md
- Code of Conduct: contributing/code-of-conduct.md
- About:
- History & Origins: about/history.md
- License: about/license.md
- Contributors: about/contributors.md
- Special Thanks: about/special-thanks.md
- Get Help: help.md
- Support: support.md
|
