Merge pull request sundowndev#179 from sundowndev/develop

Use admonition annotations in documentation

docs/googlesearch.md

@@ -28,10 +28,10 @@ If you have a Google search console API key, all you have to do is to edit the f
 
 By default, PhoneInfo uses Selenium to handle Google search feature. When running OSINT scans, you will usually be blacklisted very easily by Google, which will ask the tool to complete a captcha. Nothing more simple, just complete the captcha that appears on the firefox window. Then press ENTER in the CLI to tell the tool it can continue the scanning process.
 
-If the tool can't find your browser executable, you can specify the Firefox executable path in `config.py` or leave it blank to use the default configuration.
+!!! warning "If the tool can't find your browser executable, you can specify the Firefox executable path in `config.py` or leave it blank to use the default configuration."
 
-Still having issues with Google captcha ? Please [open an issue](https://github.com/sundowndev/PhoneInfoga/issues).
-**Be careful, the cookie contain your IP address.**
+!!! failure
+        Still having issues with Google captcha ? Please [open an issue](https://github.com/sundowndev/PhoneInfoga/issues). **Please don't disclose any personal data.**
 
 #### Using Docker
 
@@ -56,7 +56,8 @@ Here's an example of VNC URL :
 vnc://127.0.0.1:5900
 ```
 
-Also make sure you disabled any `read-only` or `view-only` mode so you can interact with the browser in order to complete the captcha.
+!!! tip
+        Also make sure you disabled any `read-only` or `view-only` mode so you can interact with the browser in order to complete the captcha.
 
 ##### VNC clients
 

docs/install.md

@@ -2,8 +2,8 @@ To install PhoneInfoga, you'll need to download source code then install depende
 
 Requirements : 
 
-- python3 and python3-pip OR Docker
-- git OR wget and curl
+- python3 and python3-pip **OR** Docker
+- git **OR** wget and curl
 
 ## Manual installation
 
@@ -42,7 +42,9 @@ python3 phoneinfoga.py -v
 
 ### Install the Geckodriver
 
-The Geckodriver is the Firefox webdriver for Selenium, which is used by PhoneInfoga to perform queries to Google search and handle captcha. Firefox is actually the only webdriver supported by PhoneInfoga. Want to hack it to use chrome or another driver instead ? See [this file](https://github.com/sundowndev/PhoneInfoga/blob/8179fe4857ca7df2d843119e2123c260e8401818/lib/googlesearch.py#L35).
+The Geckodriver is the Firefox webdriver for Selenium, which is used by PhoneInfoga to perform queries to Google search and handle captcha. Firefox is actually the only webdriver supported by PhoneInfoga.
+
+!!! tip "Want to hack it to use chrome or another driver instead ? See [this file](https://github.com/sundowndev/PhoneInfoga/blob/8179fe4857ca7df2d843119e2123c260e8401818/lib/googlesearch.py#L35)."
 
 #### Linux
 
@@ -72,10 +74,11 @@ sudo chmod +x /usr/bin/geckodriver
 rm geckodriver-*.tar.gz
 ```
 
-**NOTE:** You also have to install Firefox browser v65+. To verify everything is fine, be sure the following commands work:
+!!! note
+    You also have to install Firefox browser v65+. To verify everything is fine, be sure the following commands work:
 
-- `which firefox` should return something like `/usr/bin/firefox`
-- `which geckodriver` should return something like `/usr/bin/geckodriver`
+    - `which firefox` should return something like `/usr/bin/firefox`
+    - `which geckodriver` should return something like `/usr/bin/geckodriver`
 
 #### Windows or MacOS
 
@@ -98,7 +101,8 @@ Then run the tool
 ```shell
 docker run --rm -it sundowndev/phoneinfoga --help
 ```
-**WARNING**: This image only contain the python tool and not the Selenium hub which is useful to query Google. In order to use Selenium driver, you must use the docker-compose configuration, as described below.
+!!! warning 
+    This image only contain the python tool and not the Selenium hub which is useful to query Google. In order to use Selenium driver, you must use the docker-compose configuration, as described below.
 
 ### Docker-compose
 

docs/resources.md

@@ -17,7 +17,8 @@
 
 ## Footprinting
 
-Both free and premium resources are included. Be careful, the listing of a data source here does not mean it has been verified or is used in the tool. Data might be false. Use it as an OSINT framework.
+!!! info
+    Both free and premium resources are included. Be careful, the listing of a data source here does not mean it has been verified or is used in the tool. Data might be false. Use it as an OSINT framework.
 
 ### Reputation / fraud
 

docs/usage.md

@@ -33,7 +33,7 @@ Country code and special chars such as `( ) - +` will be escaped so typing US-ba
 python3 phoneinfoga.py -n "+1 555-444-3333"
 ```
 
-Note that the country code is essential. You don't know which country code to use ? [Find it here](https://www.countrycode.org/)
+!!! note "Note that the country code is essential. You don't know which country code to use ? [Find it here](https://www.countrycode.org/)"
 
 #### Output file
 
@@ -73,7 +73,7 @@ Use `any` to disable this feature. Default value: `all`
 
 **Footprints** scanner uses Google search engine and [Google Dorks](https://en.wikipedia.org/wiki/Google_hacking) to search phone number's footprints everywhere on the web. It allows you to search for scam reports, social media profiles, documents and more.
 
-#### Examples
+## Examples
 
 Check for a number range on OVH :
 

mkdocs.yml

@@ -25,3 +25,7 @@ extra:
       link: 'https://github.com/sundowndev/PhoneInfoga'
     - type: 'twitter'
       link: 'https://twitter.com/sundowndev'
+
+# Extensions
+markdown_extensions:
+  - markdown.extensions.admonition