mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-05 05:52:05 +00:00
ff1248cd28
* more content for F.A.Q. * more content * normalize * more content * maybe fix the docs check * absolute img urls * fix tests
179 lines
5.5 KiB
Python
Executable File
179 lines
5.5 KiB
Python
Executable File
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
from __future__ import unicode_literals
|
|
|
|
import datetime
|
|
import os
|
|
import subprocess
|
|
|
|
import jinja2
|
|
import markdown.inlinepatterns
|
|
import markdown.extensions
|
|
import markdown.util
|
|
import macros.plugin
|
|
|
|
import slugify as slugify_impl
|
|
|
|
import amp
|
|
import website
|
|
|
|
|
|
def slugify(value, separator):
|
|
return slugify_impl.slugify(value, separator=separator, word_boundary=True, save_order=True)
|
|
|
|
|
|
MARKDOWN_EXTENSIONS = [
|
|
'mdx_clickhouse',
|
|
'admonition',
|
|
'attr_list',
|
|
'def_list',
|
|
'codehilite',
|
|
'nl2br',
|
|
'sane_lists',
|
|
'pymdownx.details',
|
|
'pymdownx.magiclink',
|
|
'pymdownx.superfences',
|
|
'extra',
|
|
{
|
|
'toc': {
|
|
'permalink': True,
|
|
'slugify': slugify
|
|
}
|
|
}
|
|
]
|
|
|
|
|
|
class ClickHouseLinkMixin(object):
|
|
|
|
def handleMatch(self, m, data):
|
|
single_page = (os.environ.get('SINGLE_PAGE') == '1')
|
|
try:
|
|
el, start, end = super(ClickHouseLinkMixin, self).handleMatch(m, data)
|
|
except IndexError:
|
|
return
|
|
|
|
if el is not None:
|
|
href = el.get('href') or ''
|
|
is_external = href.startswith('http:') or href.startswith('https:')
|
|
if is_external:
|
|
if not href.startswith('https://clickhouse.tech'):
|
|
el.set('rel', 'external nofollow noreferrer')
|
|
elif single_page:
|
|
if '#' in href:
|
|
el.set('href', '#' + href.split('#', 1)[1])
|
|
else:
|
|
el.set('href', '#' + href.replace('/index.md', '/').replace('.md', '/'))
|
|
return el, start, end
|
|
|
|
|
|
class ClickHouseAutolinkPattern(ClickHouseLinkMixin, markdown.inlinepatterns.AutolinkInlineProcessor):
|
|
pass
|
|
|
|
|
|
class ClickHouseLinkPattern(ClickHouseLinkMixin, markdown.inlinepatterns.LinkInlineProcessor):
|
|
pass
|
|
|
|
|
|
class ClickHousePreprocessor(markdown.util.Processor):
|
|
def run(self, lines):
|
|
if os.getenv('QLOUD_TOKEN'):
|
|
for line in lines:
|
|
if '<!--hide-->' not in line:
|
|
yield line
|
|
else:
|
|
for line in lines:
|
|
yield line
|
|
|
|
|
|
class ClickHouseMarkdown(markdown.extensions.Extension):
|
|
|
|
def extendMarkdown(self, md, md_globals):
|
|
md.preprocessors['clickhouse'] = ClickHousePreprocessor()
|
|
md.inlinePatterns['link'] = ClickHouseLinkPattern(markdown.inlinepatterns.LINK_RE, md)
|
|
md.inlinePatterns['autolink'] = ClickHouseAutolinkPattern(markdown.inlinepatterns.AUTOLINK_RE, md)
|
|
|
|
|
|
def makeExtension(**kwargs):
|
|
return ClickHouseMarkdown(**kwargs)
|
|
|
|
|
|
def get_translations(dirname, lang):
|
|
import babel.support
|
|
return babel.support.Translations.load(
|
|
dirname=dirname,
|
|
locales=[lang, 'en']
|
|
)
|
|
|
|
|
|
class PatchedMacrosPlugin(macros.plugin.MacrosPlugin):
|
|
disabled = False
|
|
skip_git_log = False
|
|
|
|
def on_config(self, config):
|
|
super(PatchedMacrosPlugin, self).on_config(config)
|
|
self.env.comment_start_string = '{##'
|
|
self.env.comment_end_string = '##}'
|
|
self.env.loader = jinja2.FileSystemLoader([
|
|
os.path.join(config.data['site_dir']),
|
|
os.path.join(config.data['extra']['includes_dir'])
|
|
])
|
|
|
|
def on_env(self, env, config, files):
|
|
env.add_extension('jinja2.ext.i18n')
|
|
dirname = os.path.join(config.data['theme'].dirs[0], 'locale')
|
|
lang = config.data['theme']['language']
|
|
env.install_gettext_translations(
|
|
get_translations(dirname, lang),
|
|
newstyle=True
|
|
)
|
|
chunk_size = 10240
|
|
env.filters['chunks'] = lambda line: [line[i:i+chunk_size] for i in range(0, len(line), chunk_size)]
|
|
env.filters['html_to_amp'] = amp.html_to_amp
|
|
env.filters['adjust_markdown_html'] = website.adjust_markdown_html
|
|
return env
|
|
|
|
def render(self, markdown):
|
|
if not self.disabled:
|
|
return self.render_impl(markdown)
|
|
else:
|
|
return markdown
|
|
|
|
def on_page_markdown(self, markdown, page, config, files):
|
|
markdown = super(PatchedMacrosPlugin, self).on_page_markdown(markdown, page, config, files)
|
|
|
|
if os.path.islink(page.file.abs_src_path):
|
|
lang = config.data['theme']['language']
|
|
page.canonical_url = page.canonical_url.replace(f'/{lang}/', '/en/', 1)
|
|
|
|
if config.data['extra'].get('version_prefix') or config.data['extra'].get('single_page'):
|
|
return markdown
|
|
if self.skip_git_log:
|
|
return markdown
|
|
src_path = page.file.abs_src_path
|
|
try:
|
|
git_log = subprocess.check_output(f'git log --follow --date=iso8601 "{src_path}"', shell=True)
|
|
except subprocess.CalledProcessError:
|
|
return markdown
|
|
max_date = None
|
|
min_date = None
|
|
for line in git_log.decode('utf-8').split('\n'):
|
|
if line.startswith('Date:'):
|
|
line = line.replace('Date:', '').strip().replace(' ', 'T', 1).replace(' ', '')
|
|
current_date = datetime.datetime.fromisoformat(line[:-2] + ':' + line[-2:])
|
|
if (not max_date) or current_date > max_date:
|
|
max_date = current_date
|
|
if (not min_date) or current_date < min_date:
|
|
min_date = current_date
|
|
if min_date:
|
|
page.meta['published_date'] = min_date
|
|
if max_date:
|
|
page.meta['modified_date'] = max_date
|
|
return markdown
|
|
|
|
def render_impl(self, markdown):
|
|
md_template = self.env.from_string(markdown)
|
|
return md_template.render(**self.variables)
|
|
|
|
|
|
macros.plugin.MacrosPlugin = PatchedMacrosPlugin
|