Redo "内部リンクを相対リンクで生成する機能 with settings.USE_RELATIVE_LINK = True"

This reverts commit e4597df, which was
actually the reverse commit for the change
61156b4 made to
af55908.

Author: akinomyoga

.gitignore

@@ -1,11 +1,16 @@
 *.pyc
 cpprefjp/site/
+cpprefjp/image/
 cpprefjp/cpprefjp.github.io/
+cpprefjp/cpprefjp.relative/
 boostjp/site/
+boostjp/image/
 boostjp/boostjp.github.io/
+boostjp/boostjp.relative/
 settings.*.cache
 
 /crsearch.json/crsearch.json
+/crsearch.json/crsearch.js
 /cpprefjp/static/static/kunai
 /cpprefjp/static/static/crsearch/*
 

README.md

@@ -24,6 +24,7 @@ $ git submodule update -i
 
 ```bash
 git clone https://github.com/cpprefjp/site.git cpprefjp/site
+git clone https://github.com/cpprefjp/image.git cpprefjp/image
 
 # kunai 用のデータを生成する
 git clone https://github.com/cpprefjp/kunai.git
@@ -45,6 +46,7 @@ popd
 mkdir -p cpprefjp/static/static/crsearch
 pushd cpprefjp/static/static/crsearch
 ln -s ../../../../crsearch.json/crsearch.json crsearch.json
+ln -s ../../../../crsearch.json/crsearch.js crsearch.js # Optional (ローカル file:///... で閲覧する場合に必要)
 popd
 
 # site_generator 用の docker イメージを生成する
@@ -56,6 +58,7 @@ popd
 ```bash
 # この辺は必要に応じて実行する
 (cd cpprefjp/site && git pull)
+(cd cpprefjp/image && git pull)
 ./crsearch.json/docker.sh run
 ./kunai/docker.sh run build
 
@@ -74,6 +77,7 @@ http://localhost:8000 を開けば `index.html` が表示されます。
 
 ```bash
 git clone https://github.com/boostjp/site.git boostjp/site
+git clone https://github.com/boostjp/image.git boostjp/image
 
 # site_generator 用の docker イメージを生成する
 ./docker.sh build

boostjp/templates/base.html

@@ -26,15 +26,15 @@
 
         {% block rss %}{% endblock %}
 
-<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
-<link rel="stylesheet" href="/static/pygments/default.css">
-<!-- <link rel="stylesheet" href="/static/css/root.css"> -->
+<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
+<link rel="stylesheet" href="{{ relative_base }}/static/pygments/default.css">
+<!-- <link rel="stylesheet" href="{{ relative_base }}/static/css/root.css"> -->
 
-<script src="//code.jquery.com/jquery-2.1.1.min.js"></script>
-<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
-<!-- <script src="//platform.twitter.com/widgets.js"></script> -->
+<script src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
+<!-- <script src="https://platform.twitter.com/widgets.js"></script> -->
 
-<!-- <script src="/static/js/root.js"></script> -->
+<!-- <script src="{{ relative_base }}/static/js/root.js"></script> -->
 
         {% block mathjax %}{% endblock %}
 
@@ -254,7 +254,7 @@
           <span class="icon-bar"></span>
           <span class="icon-bar"></span>
         </button>
-        <a class="navbar-brand" href="/">
+        <a class="navbar-brand" href="{{ relative_index }}">
           <div class="title-wrapper clearfix">
             <div class="title">{% block brand %}{% endblock %}</div>
           </div>
@@ -326,7 +326,7 @@
     </body>
     <!-- Prompt IE 6 users to install Chrome Frame. Remove this if you want to support IE 6.  chromium.org/developers/how-tos/chrome-frame-getting-started -->
     <!--[if lt IE 7 ]>
-        <script src="//ajax.googleapis.com/ajax/libs/chrome-frame/1.0.3/CFInstall.min.js"></script>
+        <script src="https://ajax.googleapis.com/ajax/libs/chrome-frame/1.0.3/CFInstall.min.js"></script>
         <script>
             window.attachEvent('onload',function(){CFInstall.check({mode:'overlay'})})
         </script>

boostjp/templates/content.html

@@ -15,7 +15,7 @@
       <li {{ 'style="display: none"' if not parent_opened }} class="parent_li {{ 'active' if child.opened }}">
         <span class="treespan" onclick="tree_onclick.call(this, event)"><i class="glyphicon {{ 'glyphicon-minus' if child.opened else 'glyphicon-plus' }}"></i></span>
         {% if child.href %}
-          <a href="{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
+          <a href="{{ relative_base }}{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
         {% else %}
           {{ child.title|e }}{{ child.encoded_cpp_meta }}
         {% endif %}
@@ -26,7 +26,7 @@
     {% else %}
       <li {{ 'style="display: none"' if not parent_opened }}>
         {% if child.href %}
-          <a href="{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
+          <a href="{{ relative_base }}{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
         {% else %}
           {{ child.title|e }}{{ child.encoded_cpp_meta }}
         {% endif %}
@@ -49,7 +49,7 @@
       <li {{ 'class="active"' if header.is_active }} itemscope itemtype="http://www.schema.org/SiteNavigationElement">
         <span>
           {% if not header.is_active and header.href %}
-            <a href="{{ header.href }}" itemprop="url">
+            <a href="{{ relative_base }}{{ header.href }}" itemprop="url">
               {% if loop.index == 1 %}
                 <i class="glyphicon glyphicon-home"></i>
               {% else %}

cpprefjp/ghwebhook_on_user.sh

@@ -60,6 +60,7 @@ cp crsearch.json/crsearch.json cpprefjp/static/static/crsearch/
 # サイト生成
 clone_and_fallback cpprefjp/cpprefjp.github.io [email protected]:cpprefjp/cpprefjp.github.io.git
 clone_and_fallback cpprefjp/site [email protected]:cpprefjp/site.git
+clone_and_fallback cpprefjp/image [email protected]:cpprefjp/image.git
 ./docker.sh build
 ./docker.sh run settings.cpprefjp "$@"
 

cpprefjp/templates/base.html

@@ -22,24 +22,24 @@
 
         {% block rss %}{% endblock %}
 
-<link rel="apple-touch-icon" sizes="180x180" href="/static/favicons/apple-touch-icon.png{{ cachebust }}">
-<link rel="icon" type="image/png" sizes="32x32" href="/static/favicons/favicon-32x32.png{{ cachebust }}">
-<link rel="icon" type="image/png" sizes="16x16" href="/static/favicons/favicon-16x16.png{{ cachebust }}">
-<link rel="manifest" href="/static/favicons/manifest.json{{ cachebust }}">
+<link rel="apple-touch-icon" sizes="180x180" href="{{ relative_base }}/static/favicons/apple-touch-icon.png{{ cachebust }}">
+<link rel="icon" type="image/png" sizes="32x32" href="{{ relative_base }}/static/favicons/favicon-32x32.png{{ cachebust }}">
+<link rel="icon" type="image/png" sizes="16x16" href="{{ relative_base }}/static/favicons/favicon-16x16.png{{ cachebust }}">
+<link rel="manifest" href="{{ relative_base }}/manifest.json{{ cachebust }}">
 <meta name="theme-color" content="#f5f8fc">
 
-<link rel="stylesheet" href="/static/pygments/default.css{{ cachebust }}">
-<!-- <link rel="stylesheet" href="/static/css/root.css"> -->
+<link rel="stylesheet" href="{{ relative_base }}/static/pygments/default.css{{ cachebust }}">
+<!-- <link rel="stylesheet" href="{{ relative_base }}/static/css/root.css"> -->
 
         {% block mathjax %}{% endblock %}
 
-<link href="/static/kunai/css/kunai-stage-0.css{{ cachebust }}" rel="stylesheet">
-<link href="/static/kunai/css/kunai-stage-1.css{{ cachebust }}" rel="stylesheet">
-<link href="/static/kunai/css/kunai-stage-2.css{{ cachebust }}" rel="stylesheet">
-<link href="/static/kunai/css/kunai-stage-3.css{{ cachebust }}" rel="stylesheet">
+<link href="{{ relative_base }}/static/kunai/css/kunai-stage-0.css{{ cachebust }}" rel="stylesheet">
+<link href="{{ relative_base }}/static/kunai/css/kunai-stage-1.css{{ cachebust }}" rel="stylesheet">
+<link href="{{ relative_base }}/static/kunai/css/kunai-stage-2.css{{ cachebust }}" rel="stylesheet">
+<link href="{{ relative_base }}/static/kunai/css/kunai-stage-3.css{{ cachebust }}" rel="stylesheet">
 
-<script type="text/javascript" src="/static/kunai/js/kunai-vendor.js{{ cachebust }}"></script>
-<script type="text/javascript" src="/static/kunai/js/kunai.js{{ cachebust }}"></script>
+<script type="text/javascript" src="{{ relative_base }}/static/kunai/js/kunai-vendor.js{{ cachebust }}"></script>
+<script type="text/javascript" src="{{ relative_base }}/static/kunai/js/kunai.js{{ cachebust }}"></script>
 
 <script type="text/javascript">
   document.addEventListener('DOMContentLoaded', function() {
@@ -60,7 +60,7 @@
           <span class="icon-bar"></span>
           <span class="icon-bar"></span>
         </button>
-        <a class="navbar-brand" href="/">
+        <a class="navbar-brand" href="{{ relative_index }}">
           <div class="title-wrapper clearfix">
             <div class="title">{% block brand %}{% endblock %}</div>
           </div>

cpprefjp/templates/content.html

@@ -17,7 +17,7 @@
       <li class="parent_li {{ 'active' if child.opened }}">
         <span class="treespan"></span>
         {% if child.href %}
-          <a href="{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
+          <a href="{{ relative_base }}{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
         {% else %}
           {{ child.title|e }}{{ child.encoded_cpp_meta }}
         {% endif %}
@@ -28,7 +28,7 @@
     {% else %}
       <li>
         {% if child.href %}
-          <a href="{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
+          <a href="{{ relative_base }}{{ child.href }}">{{ child.title|e }}</a>{{ child.encoded_cpp_meta }}
         {% else %}
           {{ child.title|e }}{{ child.encoded_cpp_meta }}
         {% endif %}
@@ -58,7 +58,7 @@
       <li {{ 'class="active"' if header.is_active }} itemscope itemtype="http://www.schema.org/SiteNavigationElement">
         <span>
           {% if not header.is_active and header.href %}
-            <a href="{{ header.href }}" itemprop="url">
+            <a href="{{ relative_base }}{{ header.href }}" itemprop="url">
               {% if loop.index == 1 %}
                 <i class="fa fa-fw fa-home"></i>
               {% else %}

crsearch.json/run.py

@@ -487,8 +487,11 @@ def main():
     paths = chain.from_iterable([get_files(d) for d in _KNOWN_DIRS])
     all_paths = list(get_files('site'))
     result = Generator().generate('site', paths, all_paths)
+    crsearch_json = json.dumps(result, separators=(',', ':'), ensure_ascii=False, sort_keys=True)
     with open('crsearch.json', 'wb') as f:
-        f.write(json.dumps(result, separators=(',', ':'), ensure_ascii=False, sort_keys=True).encode('utf-8'))
+        f.write(crsearch_json.encode('utf-8'))
+    with open('crsearch.js', 'wb') as f:
+        f.write(('callback(%s)' % crsearch_json).encode('utf-8'))
 
 
 if __name__ == '__main__':

markdown_to_html

@@ -6,6 +6,7 @@
 import importlib
 import json
 import os
+import posixpath
 import re
 import subprocess
 import sys
@@ -69,6 +70,9 @@ def md_to_html(md_data, path, hrefs=None, global_qualify_list=None, global_defin
         'base_path': '/'.join(paths[:-1]),
         'full_path': path + '.md',
         'extension': '.html',
+        'use_relative_link': settings.USE_RELATIVE_LINK,
+        'image_repo': settings.IMAGE_REPO,
+        'use_static_image': settings.IMAGE_DIR is not None,
     }
     extension_configs['codehilite'] = {
         'noclasses': False
@@ -510,11 +514,11 @@ def convert_pageinfo(pageinfo, sidebar, sidebar_index, template, hrefs, global_q
         sidebar.set_active(pageinfo['paths'])
 
     content_header = ContentHeader(pageinfo['paths'], sidebar, sidebar_index)
-    convert(pageinfo['path'], template, {
+    context = {
         'title': (
             pageinfo['title'] if pageinfo['is_index'] else
             pageinfo['title'] + settings.TITLE_SUFFIX),
-        'url': settings.BASE_URL + '/' + pageinfo['href'],
+        'url': settings.BASE_URL + pageinfo['href'],
         'description': pageinfo['description'],
         'cachebust': _CACHEBUST,
         'disable_sidebar': settings.DISABLE_SIDEBAR,
@@ -530,7 +534,18 @@ def convert_pageinfo(pageinfo, sidebar, sidebar_index, template, hrefs, global_q
         'project_name': settings.PROJECT_NAME,
         'latest_commit_info': latest_commit_info,
         'keywords': settings.META_KEYWORDS,
-    }, hrefs, global_qualify_list, global_defined_words)
+        'relative_base': '',
+        'relative_index': '/'
+    }
+    if settings.USE_RELATIVE_LINK:
+        url_current_dir = posixpath.dirname(context['url'])
+        context['relative_base'] = posixpath.relpath(settings.BASE_URL, url_current_dir)
+        # Note: ローカル (file:///) で閲覧時にディレクトリを開いてしまわないように "/" で終わらず "index.html"も明示する。
+        context['relative_index'] = posixpath.relpath(settings.BASE_URL, url_current_dir) + '/index.html'
+        # Note: 以下は <meta /> で埋め込む情報なので敢えて相対パスにはしない。
+        # context['url'] = posixpath.relpath(context['url'], url_current_dir)
+        # context['rss'] = posixpath.relpath(context['rss'], url_current_dir)
+    convert(pageinfo['path'], template, context, hrefs, global_qualify_list, global_defined_words)
 
 
 def main():
@@ -607,6 +622,13 @@ def run(pageinfos):
     # 静的ファイルをコピーする
     subprocess.call(['cp', '-v', '-RL'] + glob.glob(os.path.join(settings.STATIC_DIR, '*')) + [settings.OUTPUT_DIR])
 
+    # 画像リポジトリ (image) の画像ファイル (*.png, *.jpg, *.svg) をコピーする
+    if settings.IMAGE_DIR is not None:
+        os.system("cd '%s' && find . -name '*.png' -or -name '*.jpg' -or -name '*.svg' | tee /dev/stderr | cpio -updmv '%s'" % (
+            settings.IMAGE_DIR,
+            os.path.relpath(os.path.join(settings.OUTPUT_DIR, 'static/image'), settings.IMAGE_DIR)
+        ))
+
 
 if __name__ == '__main__':
     main()

run.py

@@ -10,6 +10,10 @@
 # 静的ファイルディレクトリ
 STATIC_DIR = 'boostjp/static'
 
+# 画像ファイルディレクトリ / GitHubリポジトリ
+IMAGE_DIR = 'boostjp/image'
+IMAGE_REPO = 'boostjp/image'
+
 # 出力ディレクトリ
 OUTPUT_DIR = 'boostjp/boostjp.github.io'
 
@@ -80,6 +84,7 @@
 # 'git' => CACHEBUST_DIR のディレクトリの git rev-parse HEAD の結果を使う
 CACHEBUST_TYPE = 'time'
 
+USE_RELATIVE_LINK = False
 
 # 並び替えルール
 def get_order_priority(name):

settings/boostjp.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from .boostjp import *  # NOQA
+
+USE_MINIFY = False
+
+OUTPUT_DIR = 'boostjp/boostjp.relative'
+GOOGLE_ANALYTICS = ''
+USE_RELATIVE_LINK = True

settings/boostjp_relative.py

@@ -10,6 +10,10 @@
 # 静的ファイルディレクトリ
 STATIC_DIR = 'cpprefjp/static'
 
+# 画像ファイルディレクトリ / GitHubリポジトリ
+IMAGE_DIR = 'cpprefjp/image'
+IMAGE_REPO = 'cpprefjp/image'
+
 # 出力ディレクトリ
 OUTPUT_DIR = 'cpprefjp/cpprefjp.github.io'
 
@@ -81,6 +85,8 @@
 CACHEBUST_TYPE = 'git'
 CACHEBUST_DIR = 'kunai'
 
+USE_RELATIVE_LINK = False
+
 # 並び替えルール
 ORDER_PRIORITY_LIST = [
     'op_constructor',

settings/cpprefjp.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
+from __future__ import unicode_literals
+
+from .cpprefjp import *  # NOQA
+
+OUTPUT_DIR = 'cpprefjp/cpprefjp.relative'
+GOOGLE_ANALYTICS = ''
+USE_RELATIVE_LINK = True