diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index f6494e4cb..e4aa98cad 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -75,7 +75,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install mkdocs==1.3.0 mkdocs-material==8.3.9 mkdocs-minify-plugin==0.5.0 + python -m pip install mkdocs==1.3.0 mkdocs-material==8.3.9 mkdocs-minify-plugin==0.5.0 mkdocs-redirects==1.1.0 - name: Deploy run: | diff --git a/docs/index.md b/docs/index.md index cbaaf898d..e8c7ea9c6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,12 +11,12 @@ PhoneInfoga is one of the most advanced tools to scan international phone number ## Features -- Check if phone number exists and has connectivity status with [HLR lookups](https://www.hlr-lookups.com/en/what-is-an-hlr-lookup) -- Gather standard informations such as country, line type and carrier -- OSINT footprinting using external APIs, Google Hacking, phone books & search engines +- Check if phone number exists +- Gather basic information such as country, line type and carrier +- OSINT footprinting using external APIs, phone books & search engines - Check for reputation reports, social media, disposable numbers and more - Use the graphical user interface to run scans from the browser -- Programmatic usage with the REST API and [Go modules](https://pkg.go.dev/github.com/sundowndev/phoneinfoga/v2) +- Programmatic usage with the [REST API](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/sundowndev/phoneinfoga/master/web/docs/swagger.yaml) and [Go modules](https://pkg.go.dev/github.com/sundowndev/phoneinfoga/v2) ## Anti-features diff --git a/docs/getting-started/resources.md b/docs/resources/additional-resources.md similarity index 99% rename from docs/getting-started/resources.md rename to docs/resources/additional-resources.md index fa2d174e3..6b5c67d01 100644 --- a/docs/getting-started/resources.md +++ b/docs/resources/additional-resources.md @@ -1,4 +1,4 @@ -# Resources +# Additional resources ### Understanding phone numbers diff --git a/docs/getting-started/formatting.md b/docs/resources/formatting.md similarity index 100% rename from docs/getting-started/formatting.md rename to docs/resources/formatting.md diff --git a/mkdocs.yml b/mkdocs.yml index 6e01fa187..120375c64 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ site_name: PhoneInfoga +site_url: https://sundowndev.github.io/phoneinfoga repo_name: 'sundowndev/phoneinfoga' repo_url: 'https://github.com/sundowndev/phoneinfoga' site_description: 'Advanced information gathering & OSINT tool for phone numbers.' @@ -9,10 +10,11 @@ nav: - 'Getting Started': - 'Installation': getting-started/install.md - 'Usage': getting-started/usage.md - - 'Formatting phone numbers': getting-started/formatting.md - 'Scanners': getting-started/scanners.md - 'Go module usage': getting-started/go-module-usage.md - - 'Additional resources': getting-started/resources.md + - 'Resources': + - 'Formatting phone numbers': resources/formatting.md + - 'Additional resources': resources/additional-resources.md - 'Contribute': contribute.md theme: name: material @@ -56,3 +58,11 @@ plugins: - search - minify: minify_html: true + - redirects: + redirect_maps: + 'install.md': 'getting-started/install.md' + 'usage.md': 'getting-started/usage.md' + 'scanners.md': 'getting-started/scanners.md' + 'go-module-usage.md': 'getting-started/go-module-usage.md' + 'formatting.md': 'resources/formatting.md' + 'resources.md': 'resources/additional-resources.md'