Skip to content

Commit b643181

Browse files
committed
Refined documentation
1 parent c1d268d commit b643181

File tree

2 files changed

+83
-55
lines changed

2 files changed

+83
-55
lines changed

docs/mkdocs.yml

Lines changed: 57 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,57 @@
1-
site_author: dhondta
2-
site_name: "Codext - Extension of native codecs for Python"
3-
repo_url: https://github.com/dhondta/python-codext
4-
copyright: Copyright © 2021-2023 Alexandre D'Hondt
5-
docs_dir: pages
6-
nav:
7-
- Introduction: index.md
8-
- Features: features.md
9-
- 'Guess mode': guessing.md
10-
- Encodings:
11-
- Base: enc/base.md
12-
- Binary: enc/binary.md
13-
- Common: enc/common.md
14-
- Compressions: enc/compressions.md
15-
- Cryptography: enc/crypto.md
16-
- Hashing: enc/hashing.md
17-
- Languages: enc/languages.md
18-
- Others: enc/others.md
19-
- Steganography: enc/stegano.md
20-
- 'String manipulations': manipulations.md
21-
- 'CLI tool': cli.md
22-
- 'Create your codec': howto.md
23-
extra:
24-
generator: false
25-
social:
26-
- icon: fontawesome/solid/paper-plane
27-
link: mailto:alexandre.dhondt@gmail.com
28-
name: Contact Alex
29-
- icon: fontawesome/brands/github
30-
link: https://github.com/dhondta
31-
name: Alex on GitHub
32-
- icon: fontawesome/brands/linkedin
33-
link: https://www.linkedin.com/in/alexandre-d-2ab2aa14/
34-
name: Alex on LinkedIn
35-
- icon: fontawesome/brands/twitter
36-
link: https://twitter.com/alex_dhondt
37-
name: Alex on Twitter
38-
theme:
39-
name: material
40-
palette:
41-
- scheme: default
42-
toggle:
43-
icon: material/brightness-7
44-
name: Switch to dark mode
45-
- scheme: slate
46-
toggle:
47-
icon: material/brightness-4
48-
name: Switch to light mode
49-
logo: img/logo.png
50-
favicon: img/icon.png
51-
use_directory_urls: false
52-
markdown_extensions:
53-
- toc:
54-
permalink: true
55-
- admonition
1+
site_author: dhondta
2+
site_name: "Codext - Extension of native codecs for Python"
3+
repo_url: https://github.com/dhondta/python-codext
4+
copyright: Copyright © 2021-2023 Alexandre D'Hondt
5+
docs_dir: pages
6+
nav:
7+
- Introduction: index.md
8+
- Features: features.md
9+
- 'Guess mode': guessing.md
10+
- Encodings:
11+
- Base: enc/base.md
12+
- Binary: enc/binary.md
13+
- Common: enc/common.md
14+
- Compressions: enc/compressions.md
15+
- Cryptography: enc/crypto.md
16+
- Hashing: enc/hashing.md
17+
- Languages: enc/languages.md
18+
- Others: enc/others.md
19+
- Steganography: enc/stegano.md
20+
- 'String manipulations': manipulations.md
21+
- 'CLI tool': cli.md
22+
- 'Create your codec': howto.md
23+
extra:
24+
generator: false
25+
social:
26+
- icon: fontawesome/solid/paper-plane
27+
link: mailto:alexandre.dhondt@gmail.com
28+
name: Contact Alex
29+
- icon: fontawesome/brands/github
30+
link: https://github.com/dhondta
31+
name: Alex on GitHub
32+
- icon: fontawesome/brands/linkedin
33+
link: https://www.linkedin.com/in/alexandre-d-2ab2aa14/
34+
name: Alex on LinkedIn
35+
- icon: fontawesome/brands/twitter
36+
link: https://twitter.com/alex_dhondt
37+
name: Alex on Twitter
38+
extra_css:
39+
- css/extra.css
40+
theme:
41+
name: material
42+
palette:
43+
- scheme: default
44+
toggle:
45+
icon: material/brightness-7
46+
name: Switch to dark mode
47+
- scheme: slate
48+
toggle:
49+
icon: material/brightness-4
50+
name: Switch to light mode
51+
logo: img/logo.png
52+
favicon: img/icon.png
53+
use_directory_urls: false
54+
markdown_extensions:
55+
- toc:
56+
permalink: true
57+
- admonition

docs/pages/css/extra.css

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/* Full width (only works for some themes, including 'material') */
2+
@media only screen and (min-width: 76.25em) {
3+
.md-main__inner {
4+
max-width: none;
5+
}
6+
.md-sidebar--primary {
7+
left: 0;
8+
}
9+
.md-sidebar--secondary {
10+
right: 0;
11+
margin-left: 0;
12+
-webkit-transform: none;
13+
transform: none;
14+
}
15+
}
16+
17+
/* See https://github.com/mkdocs/mkdocs/wiki/MkDocs-Recipes */
18+
/* Add Support for Checkbox Lists */
19+
.task-list-item {
20+
list-style-type: none;
21+
}
22+
23+
.task-list-item input {
24+
margin: 0 4px 0.25em -20px;
25+
vertical-align: middle;
26+
}

0 commit comments

Comments
 (0)