Skip to content

Commit 7c79988

Browse files
committed
Updated the documentation
1 parent 13960f1 commit 7c79988

29 files changed

Lines changed: 74 additions & 96 deletions

.readthedocs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
version: 2
2+
23
mkdocs:
3-
configuration: mkdocs.yml
4-
formats: all
4+
configuration: docs/mkdocs.yml
5+
56
python:
6-
version: 3.6
7+
install:
8+
- requirements: docs/requirements.txt

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
1-
<p align="center"><img src="https://github.com/dhondta/python-codext/raw/master/docs/imgs/logo.png"></p>
1+
<p align="center"><img src="https://github.com/dhondta/python-codext/raw/main/docs/pages/img/logo.png"></p>
22
<h1 align="center">CodExt <a href="https://twitter.com/intent/tweet?text=CodExt%20-%20Encoding%2Fdecoding%20anything.%0D%0APython%20library%20extending%20the%20native%20codecs%20library%20with%20many%20new%20encodings%20and%20providing%20CLI%20tools%20with%20a%20guess%20feature%20based%20on%20AI.%0D%0Ahttps%3a%2f%2fgithub%2ecom%2fdhondta%2fpython-codext%0D%0A&hashtags=python,programming,encodings,codecs,cryptography,morse,base,ctftools"><img src="https://img.shields.io/badge/Tweet--lightgrey?logo=twitter&style=social" alt="Tweet" height="20"/></a></h1>
33
<h3 align="center">Encode/decode anything.</h3>
44

55
[![PyPi](https://img.shields.io/pypi/v/codext.svg)](https://pypi.python.org/pypi/codext/)
66
[![Read The Docs](https://readthedocs.org/projects/python-codext/badge/?version=latest)](https://python-codext.readthedocs.io/en/latest/?badge=latest)
7-
[![Build Status](https://travis-ci.com/dhondta/python-codext.svg?branch=master)](https://travis-ci.com/dhondta/python-codext)
8-
[![Coverage Status](https://coveralls.io/repos/github/dhondta/python-codext/badge.svg?branch=master)](https://coveralls.io/github/dhondta/python-codext?branch=master)
7+
[![Build Status](https://github.com/dhondta/python-codext/actions/workflows/python-package.yml/badge.svg)](https://github.com/dhondta/python-codext/actions/workflows/python-package.yml)
8+
[![Coverage Status](https://raw.githubusercontent.com/dhondta/python-codext/main/docs/coverage.svg)](#)
99
[![Python Versions](https://img.shields.io/pypi/pyversions/codext.svg)](https://pypi.python.org/pypi/codext/)
10-
[![Requirements Status](https://requires.io/github/dhondta/python-codext/requirements.svg?branch=master)](https://requires.io/github/dhondta/python-codext/requirements/?branch=master)
1110
[![Known Vulnerabilities](https://snyk.io/test/github/dhondta/python-codext/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/dhondta/python-codext?targetFile=requirements.txt)
1211
[![DOI](https://zenodo.org/badge/236679865.svg)](https://zenodo.org/badge/latestdoi/236679865)
1312
[![License](https://img.shields.io/pypi/l/codext.svg)](https://pypi.python.org/pypi/codext/)
@@ -20,13 +19,13 @@ $ pip install codext
2019

2120
Want to contribute a new codec ? | Want to contribute a new macro ?
2221
:----------------------------------:|:------------------------------------:
23-
Check the [documentation](https://python-codext.readthedocs.io/en/latest/howto.html) first<br>Then [PR](https://github.com/dhondta/python-codext/pulls) your new codec | [PR](https://github.com/dhondta/python-codext/pulls) your updated version of [`macros.json`](https://github.com/dhondta/python-codext/blob/master/codext/macros.json)
22+
Check the [documentation](https://python-codext.readthedocs.io/en/latest/howto.html) first<br>Then [PR](https://github.com/dhondta/python-codext/pulls) your new codec | [PR](https://github.com/dhondta/python-codext/pulls) your updated version of [`macros.json`](https://github.com/dhondta/python-codext/blob/main/codext/macros.json)
2423

2524
## :mag: Demonstrations
2625

27-
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/master/docs/demos/using-codext.gif" alt="Using CodExt from the command line"></p>
28-
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/master/docs/demos/using-bases.gif" alt="Using base tools from the command line"></p>
29-
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/master/docs/demos/using-unbase.gif" alt="Using the unbase command line tool"></p>
26+
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/main/docs/pages/demos/using-codext.gif" alt="Using CodExt from the command line"></p>
27+
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/main/docs/pages/demos/using-bases.gif" alt="Using base tools from the command line"></p>
28+
<p align="center"><img src="https://raw.githubusercontent.com/dhondta/python-codext/main/docs/pages/demos/using-unbase.gif" alt="Using the unbase command line tool"></p>
3029

3130
## :computer: Usage (main CLI tool) <a href="https://twitter.com/intent/tweet?text=CodExt%20-%20Encode%2Fdecode%20anything.%0D%0APython%20tool%20for%20encoding%20and%20decoding%20almost%20anything,%20including%20a%20guess%20feature%20based%20on%20AI.%0D%0Ahttps%3a%2f%2fgithub%2ecom%2fdhondta%2fpython-codext%0D%0A&hashtags=python,encodings,codecs,cryptography,morse,base,stegano,steganography,ctftools"><img src="https://img.shields.io/badge/Tweet%20(codext)--lightgrey?logo=twitter&style=social" alt="Tweet on codext" height="20"/></a>
3231

docs/coverage.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/js/collapsible-navbar.js

Lines changed: 0 additions & 54 deletions
This file was deleted.

docs/mkdocs.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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 &copy; 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
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)