From b4b49a1f523797b84811fdc1f6e4e475b0d3ab83 Mon Sep 17 00:00:00 2001 From: coliff Date: Fri, 20 Jul 2018 00:15:12 +0900 Subject: [PATCH] HTTPS Links --- CONTRIBUTING.md | 2 +- docs/about/release-notes.md | 6 +++--- docs/user-guide/configuration.md | 8 ++++---- docs/user-guide/custom-themes.md | 12 ++++++------ docs/user-guide/styling-your-docs.md | 2 +- docs/user-guide/writing-your-docs.md | 4 ++-- mkdocs/commands/new.py | 2 +- mkdocs/tests/config/base_tests.py | 2 +- mkdocs/tests/config/config_options_tests.py | 2 +- mkdocs/tests/integration/minimal/docs/testing.md | 2 +- mkdocs/tests/integration/unicode/docs/Übersicht.md | 2 +- mkdocs/tests/integration/unicode/docs/♪.md | 2 +- mkdocs/utils/__init__.py | 4 ++-- mkdocs/utils/ghp_import.py | 2 +- setup.py | 2 +- 15 files changed, 27 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77de742d..527abf61 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,4 +3,4 @@ See the contributing guide in the documentation for an introduction to contributing to MkDocs. - + diff --git a/docs/about/release-notes.md b/docs/about/release-notes.md index eb996f51..c4a071d2 100644 --- a/docs/about/release-notes.md +++ b/docs/about/release-notes.md @@ -696,8 +696,8 @@ details about these specific themes. * [MkDocs Bootstrap] * [MkDocs Bootswatch] -[MkDocs Bootstrap]: http://mkdocs.github.io/mkdocs-bootstrap/ -[MkDocs Bootswatch]: http://mkdocs.github.io/mkdocs-bootswatch/ +[MkDocs Bootstrap]: https://mkdocs.github.io/mkdocs-bootstrap/ +[MkDocs Bootswatch]: https://mkdocs.github.io/mkdocs-bootswatch/ They will be included with MkDocs by default until a future release. After that they will be installable with pip: `pip install mkdocs-bootstrap` and `pip @@ -815,7 +815,7 @@ JavaScript library [lunr.js]. It has been added to both the `mkdocs` and `readthedocs` themes. See the custom theme documentation on [supporting search] for adding it to your own themes. -[lunr.js]: http://lunrjs.com/ +[lunr.js]: https://lunrjs.com/ [supporting search]: ../user-guide/styling-your-docs.md#search-and-themes #### New Command Line Interface diff --git a/docs/user-guide/configuration.md b/docs/user-guide/configuration.md index c9a16b30..4f9f7a2b 100644 --- a/docs/user-guide/configuration.md +++ b/docs/user-guide/configuration.md @@ -199,7 +199,7 @@ site and you may want to link to other parts of the same site without including the full domain. In that case, you may use and appropriate relative URL. ```yaml -site_url: http://example.com/foo/ +site_url: https://example.com/foo/ nav: - Home: ../ @@ -211,8 +211,8 @@ In the above example, two different styles of external links are used. First note that the `site_url` indicates that the MkDocs site is hosted in the `/foo/` subdirectory of the domain. Therefore, the `Home` navigation item is a relative link which steps up one level to the server root and effectively points to -`http://example.com/`. The `Bug Tracker` item uses an absolute path from the -server root and effectively points to `http://example.com/bugs/`. Of course, the +`https://example.com/`. The `Bug Tracker` item uses an absolute path from the +server root and effectively points to `https://example.com/bugs/`. Of course, the `User Guide` points to a local MkDocs page. **default**: By default `nav` will contain an alphanumerically sorted, nested @@ -576,7 +576,7 @@ You may [contribute additional languages]. [styling your docs]: styling-your-docs.md [extra_css]: #extra_css [Plugins]: plugins.md -[lunr.js]: http://lunrjs.com/ +[lunr.js]: https://lunrjs.com/ [ISO 639-1]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes [Lunr Languages]: https://github.com/MihaiValentin/lunr-languages#lunr-languages----- [contribute additional languages]: https://github.com/MihaiValentin/lunr-languages/blob/master/CONTRIBUTING.md diff --git a/docs/user-guide/custom-themes.md b/docs/user-guide/custom-themes.md index 9faac59b..1b61b60c 100644 --- a/docs/user-guide/custom-themes.md +++ b/docs/user-guide/custom-themes.md @@ -297,9 +297,9 @@ assigned to the [site_url] configuration setting. The value includes any subdirectory included in the `site_url`, but not the domain. [base_url] should not be used with this variable. -For example, if `site_url: http://example.com/`, then the value of +For example, if `site_url: https://example.com/`, then the value of `page.abs_url` for the page `foo.md` would be `/foo/`. However, if -`site_url: http://example.com/bar/`, then the value of `page.abs_url` for the +`site_url: https://example.com/bar/`, then the value of `page.abs_url` for the page `foo.md` would be `/bar/foo/`. [site_url]: ./configuration.md#site_url @@ -484,7 +484,7 @@ extra: links: - https://github.com/mkdocs - https://docs.readthedocs.org/en/latest/builds.html#mkdocs - - http://www.mkdocs.org/ + - https://www.mkdocs.org/ ``` And then displayed with this HTML in the custom theme. @@ -636,7 +636,7 @@ index when it is available. The `index` object was new in MkDocs version *1.0*. [Jinja2 template]: http://jinja.pocoo.org/docs/dev/ [built-in themes]: https://github.com/mkdocs/mkdocs/tree/master/mkdocs/themes [theme's configuration file]: #theme-configuration -[lunr.js]: http://lunrjs.com/ +[lunr.js]: https://lunrjs.com/ [site_dir]: configuration.md#site_dir [prebuild_index]: configuration.md#prebuild_index @@ -660,8 +660,8 @@ Bootswatch theme]. their needs. [Python packaging]: https://packaging.python.org/en/latest/ -[MkDocs Bootstrap theme]: http://mkdocs.github.io/mkdocs-bootstrap/ -[MkDocs Bootswatch theme]: http://mkdocs.github.io/mkdocs-bootswatch/ +[MkDocs Bootstrap theme]: https://mkdocs.github.io/mkdocs-bootstrap/ +[MkDocs Bootswatch theme]: https://mkdocs.github.io/mkdocs-bootswatch/ ### Package Layout diff --git a/docs/user-guide/styling-your-docs.md b/docs/user-guide/styling-your-docs.md index 95278042..109cd865 100644 --- a/docs/user-guide/styling-your-docs.md +++ b/docs/user-guide/styling-your-docs.md @@ -320,7 +320,7 @@ any additional CSS files included in the `custom_dir`. [browse source]: https://github.com/mkdocs/mkdocs/tree/master/mkdocs/themes/mkdocs [built-in themes]: #built-in-themes -[Bootstrap]: http://getbootstrap.com/ +[Bootstrap]: https://getbootstrap.com/ [theme configuration options]: ./configuration.md#theme [Read the Docs]: https://readthedocs.org/ [community wiki]: https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes diff --git a/docs/user-guide/writing-your-docs.md b/docs/user-guide/writing-your-docs.md index a1790d81..c8c7cf54 100644 --- a/docs/user-guide/writing-your-docs.md +++ b/docs/user-guide/writing-your-docs.md @@ -379,7 +379,7 @@ authors: - Waylan Limberg - Tom Christie date: 2018-07-10 -some_url: http://example.com +some_url: https://example.com --- This is the first paragraph of the document. ``` @@ -407,7 +407,7 @@ Authors: Waylan Limberg Tom Christie Date: January 23, 2018 blank-value: -some_url: http://example.com +some_url: https://example.com This is the first paragraph of the document. ``` diff --git a/mkdocs/commands/new.py b/mkdocs/commands/new.py index 094b0ba1..4d7c2cc4 100644 --- a/mkdocs/commands/new.py +++ b/mkdocs/commands/new.py @@ -8,7 +8,7 @@ import os config_text = 'site_name: My Docs\n' index_text = """# Welcome to MkDocs -For full documentation visit [mkdocs.org](http://mkdocs.org). +For full documentation visit [mkdocs.org](https://mkdocs.org). ## Commands diff --git a/mkdocs/tests/config/base_tests.py b/mkdocs/tests/config/base_tests.py index 0d5e27fa..3b4223c8 100644 --- a/mkdocs/tests/config/base_tests.py +++ b/mkdocs/tests/config/base_tests.py @@ -134,7 +134,7 @@ class ConfigBaseTests(unittest.TestCase): config_file = tempfile.NamedTemporaryFile('w', delete=False) try: config_file.write( - "site_dir: output\nsite_uri: http://www.mkdocs.org\n") + "site_dir: output\nsite_uri: https://www.mkdocs.org\n") config_file.flush() config_file.close() diff --git a/mkdocs/tests/config/config_options_tests.py b/mkdocs/tests/config/config_options_tests.py index cd828e4a..0bb4a307 100644 --- a/mkdocs/tests/config/config_options_tests.py +++ b/mkdocs/tests/config/config_options_tests.py @@ -151,7 +151,7 @@ class URLTest(unittest.TestCase): def test_valid_url(self): - url = "http://mkdocs.org" + url = "https://mkdocs.org" option = config_options.URL() value = option.validate(url) diff --git a/mkdocs/tests/integration/minimal/docs/testing.md b/mkdocs/tests/integration/minimal/docs/testing.md index da37213a..d3880397 100644 --- a/mkdocs/tests/integration/minimal/docs/testing.md +++ b/mkdocs/tests/integration/minimal/docs/testing.md @@ -1,6 +1,6 @@ # Welcome to MkDocs -For full documentation visit [mkdocs.org](http://mkdocs.org). +For full documentation visit [mkdocs.org](https://mkdocs.org). ## Commands diff --git a/mkdocs/tests/integration/unicode/docs/Übersicht.md b/mkdocs/tests/integration/unicode/docs/Übersicht.md index e4109834..7b68fe7e 100644 --- a/mkdocs/tests/integration/unicode/docs/Übersicht.md +++ b/mkdocs/tests/integration/unicode/docs/Übersicht.md @@ -1,6 +1,6 @@ Welcome to MkDocs -For full documentation visit [mkdocs.org](http://mkdocs.org). +For full documentation visit [mkdocs.org](https://mkdocs.org). ## Commands diff --git a/mkdocs/tests/integration/unicode/docs/♪.md b/mkdocs/tests/integration/unicode/docs/♪.md index e4109834..7b68fe7e 100644 --- a/mkdocs/tests/integration/unicode/docs/♪.md +++ b/mkdocs/tests/integration/unicode/docs/♪.md @@ -1,6 +1,6 @@ Welcome to MkDocs -For full documentation visit [mkdocs.org](http://mkdocs.org). +For full documentation visit [mkdocs.org](https://mkdocs.org). ## Commands diff --git a/mkdocs/utils/__init__.py b/mkdocs/utils/__init__.py index 8ee33424..01d35bd1 100644 --- a/mkdocs/utils/__init__.py +++ b/mkdocs/utils/__init__.py @@ -54,7 +54,7 @@ def yaml_load(source, loader=yaml.Loader): Wrap PyYaml's loader so we can extend it to suit our needs. Load all strings as unicode. - http://stackoverflow.com/a/2967461/3609487 + https://stackoverflow.com/a/2967461/3609487 """ def construct_yaml_str(self, node): @@ -188,7 +188,7 @@ def is_markdown_file(path): """ Return True if the given file path is a Markdown file. - http://superuser.com/questions/249436/file-extension-for-markdown-files + https://superuser.com/questions/249436/file-extension-for-markdown-files """ return any(fnmatch.fnmatch(path.lower(), '*{0}'.format(x)) for x in markdown_extensions) diff --git a/mkdocs/utils/ghp_import.py b/mkdocs/utils/ghp_import.py index 62ef8c5c..b585a897 100644 --- a/mkdocs/utils/ghp_import.py +++ b/mkdocs/utils/ghp_import.py @@ -62,7 +62,7 @@ else: def normalize_path(path): # Fix unicode pathnames on OS X - # See: http://stackoverflow.com/a/5582439/44289 + # See: https://stackoverflow.com/a/5582439/44289 if sys.platform == "darwin": return unicodedata.normalize("NFKC", dec(path)) return path diff --git a/setup.py b/setup.py index e9f51465..47e51835 100755 --- a/setup.py +++ b/setup.py @@ -47,7 +47,7 @@ if sys.argv[-1] == 'publish': setup( name="mkdocs", version=get_version("mkdocs"), - url='http://www.mkdocs.org', + url='https://www.mkdocs.org', license='BSD', description='Project documentation with Markdown.', long_description=long_description,