mirror of
https://github.com/Hopiu/linkchecker.git
synced 2026-03-19 23:40:29 +00:00
check links in web documents or full websites
05c02da2b0
It is confusing to have different versions of the code self-identify with the same version number. In my experience it's always best to increment the version number and add a .dev0 suffix right after making a release. When it's time to make a new release, you remove the .dev0, commit, tag that commit, then make second commit that bumps the version and adds .dev0 back. This way only releases identify themselves as "version X.Y.Z" with no .dev0 suffix and it's immediatelly apparent when you've got a prerelease installed from git. |
||
|---|---|---|
| .github | ||
| cgi-bin | ||
| config | ||
| doc | ||
| linkcheck | ||
| po | ||
| scripts | ||
| tests | ||
| windows | ||
| .gitattributes | ||
| .gitignore | ||
| .project | ||
| .pydevproject | ||
| .travis.yml | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.mdwn | ||
| COPYING | ||
| dev-requirements.txt | ||
| Dockerfile | ||
| install-rpm.sh | ||
| linkchecker | ||
| linkchecker.freecode | ||
| Makefile | ||
| MANIFEST.in | ||
| pytest.ini | ||
| README.rst | ||
| requirements.txt | ||
| robots.txt | ||
| setup.cfg | ||
| setup.py | ||
| tox.ini | ||
LinkChecker ============ |Build Status|_ |License|_ .. |Build Status| image:: https://travis-ci.com/linkchecker/linkchecker.svg?branch=master .. _Build Status: https://travis-ci.com/linkchecker/linkchecker .. |License| image:: http://img.shields.io/badge/license-GPL2-d49a6a.svg .. _License: http://opensource.org/licenses/GPL-2.0 Check for broken links in web sites. Features --------- - recursive and multithreaded checking and site crawling - output in colored or normal text, HTML, SQL, CSV, XML or a sitemap graph in different formats - HTTP/1.1, HTTPS, FTP, mailto:, news:, nntp:, Telnet and local file links support - restrict link checking with regular expression filters for URLs - proxy support - username/password authorization for HTTP, FTP and Telnet - honors robots.txt exclusion protocol - Cookie support - HTML5 support - a command line and web interface - various check plugins available, eg. HTML syntax and antivirus checks. Installation ------------- See `doc/install.txt`_ in the source code archive for general information. Except the given information there, please take note of the following: .. _doc/install.txt: doc/install.txt Python 3 or later is needed. The version in the pip repository is old. Instead, you can use pip to install the latest release from git: ``pip install git+https://github.com/linkchecker/linkchecker.git@v9.4.0``. See `#4 <https://github.com/linkchecker/linkchecker/pull/4>`_. Windows builds are seriously lagging behind the Linux releases, see `#53 <https://github.com/linkchecker/linkchecker/issues/53>`_ for details. For now, the only two options are to install from source or use `Docker for Windows <https://www.docker.com/docker-windows>`_. Usage ------ Execute ``linkchecker http://www.example.com``. For other options see ``linkchecker --help``. Docker usage ------------- If you do not want to install any additional libraries/dependencies you can use the Docker image. Example for external web site check: ``` docker run --rm -it -u $(id -u):$(id -g) linkchecker/linkchecker --verbose https://google.com ``` Local HTML file check: ``` docker run --rm -it -u $(id -u):$(id -g) -v "$PWD":/mnt linkchecker/linkchecker --verbose index.html ```