diff --git a/website/README.md b/website/README.md index 623f6e29..6b2cfab7 100644 --- a/website/README.md +++ b/website/README.md @@ -53,7 +53,9 @@ verify_updates.py 在临时副本中修改文章、替换配图、新增文章 首页学习站横幅下面是“今日面试题”:每天按日期从面试最常问的题中换一道,链接到这道题在学习站中的页面。 -构建时在根目录写入 robots.txt,指向学习站的站点地图(learn/sitemap.xml,列出每道题的静态页面)。 +每篇笔记另外生成一个静态页面(notes/<名字>.html,builder/static_notes.cjs):网站本身的地址在 # 之后,搜索引擎只收录得到首页,静态页面是渲染好的正文,没有脚本,标题的 id 与网站一致(按 Docsify 的规则),站内链接指向其它笔记的静态页面,页面上有回到阅读器的链接;只剩一个链接的旧页面跳到目标页。Markdown 用 marked 1.2.9 渲染(和 Docsify 4.13.1 依赖的版本相同,文件及许可证在 builder/vendor 中),构建时需要 Node.js。 + +构建时在根目录写入站点地图 sitemap.xml(首页和这些静态页面)和 robots.txt,robots.txt 同时指向学习站的站点地图(learn/sitemap.xml,列出每道题的静态页面)。 ## 自动更新与发布 diff --git a/website/builder/build.py b/website/builder/build.py index 5a25d8ea..aa34cee7 100644 --- a/website/builder/build.py +++ b/website/builder/build.py @@ -298,7 +298,7 @@ def build(optimize=True): (dist / '_404.md').write_text('# 页面暂未找到\n\n请从目录或搜索查找笔记。\n\n[返回首页](/)\n') (dist / '.nojekyll').touch() # 允许收录;学习站每道题的页面列在它的站点地图中(笔记页面在 # 之后,没有单独的地址) - (dist / 'robots.txt').write_text('User-agent: *\nAllow: /\n' + (f'Sitemap: {SITE_URL}learn/sitemap.xml\n' if LEARN_BUILD.is_file() else '')) + (dist / 'robots.txt').write_text('User-agent: *\nAllow: /\n' + f'Sitemap: {SITE_URL}sitemap.xml\n' + (f'Sitemap: {SITE_URL}learn/sitemap.xml\n' if LEARN_BUILD.is_file() else '')) shutil.copyfile(ROOT / 'docs/_media/LogoMakr_1J56bI.png', dist / 'favicon.png') write_app_icons(dist, ROOT / 'docs/_media/LogoMakr_1J56bI.png') learn_report = None @@ -333,6 +333,14 @@ def build(optimize=True): image_report['sized'] = add_image_sizes(dist) index_name, search_report = write_search_index(dist, sorted((dist / 'notes').glob('*.md'))) animations = write_animations(dist) + # 每篇笔记的静态页面(notes/<名字>.html,搜索引擎收录用)和站点地图;配图已经换成优化后的地址、补上高度 + stubs_file = CACHE / 'stubs.json' + stubs_file.parent.mkdir(parents=True, exist_ok=True) + stubs_file.write_text(json.dumps(stubs, ensure_ascii=False)) + static_urls = json.loads(subprocess.run(['node', str(Path(__file__).parent / 'static_notes.cjs'), str(dist), SITE_URL, str(stubs_file)], + check=True, capture_output=True, text=True).stdout) + (dist / 'sitemap.xml').write_text('\n\n' + + ''.join(f' {html.escape(url)}\n' for url in [SITE_URL] + static_urls) + '\n') legacy = json.loads((SITE / 'legacy-routes.json').read_text()) (dist / 'search-paths.js').write_text( 'window.CS_NOTES_PATHS = ' + json.dumps(note_paths, ensure_ascii=False) + ';\n' @@ -345,12 +353,12 @@ def build(optimize=True): 'window.CS_NOTES_LEARN_SECTIONS = ' + json.dumps(learn_sections, ensure_ascii=False, separators=(',', ':')) + ';\n') generator = hashlib.sha256() learn = [*LEARN_BUILD.parent.glob('*.py'), *(LEARN_BUILD.parent / 'src').rglob('*')] if LEARN_BUILD.is_file() else [] - for resource in sorted([*Path(__file__).parent.glob('*.py'), *SITE.rglob('*'), *learn]): + for resource in sorted([*Path(__file__).parent.glob('*.py'), *Path(__file__).parent.glob('*.cjs'), *(Path(__file__).parent / 'vendor').rglob('*'), *SITE.rglob('*'), *learn]): if resource.is_file(): generator.update(resource.relative_to(BASE.parent).as_posix().encode()) generator.update(resource.read_bytes()) build_info = {'sourceCommit': SOURCE_COMMIT, 'generatorHash': generator.hexdigest(), 'notes': len(note_paths), - 'searchIndex': index_name, 'legacyRoutes': len(legacy)} + 'searchIndex': index_name, 'legacyRoutes': len(legacy), 'staticPages': len(static_urls)} (dist / 'build-info.json').write_text(json.dumps(build_info, indent=2) + '\n') # 网站读取的是同内容的 .txt:EdgeOne 只压缩 text/plain 等类型,.md 的 text/markdown 不压缩 for document in list(dist.rglob('*.md')): diff --git a/website/builder/static_notes.cjs b/website/builder/static_notes.cjs new file mode 100644 index 00000000..0aae59a4 --- /dev/null +++ b/website/builder/static_notes.cjs @@ -0,0 +1,165 @@ +// 每篇笔记生成一个静态页面(notes/<名字>.html):网站本身用 # 之后的地址,搜索引擎只收录得到首页; +// 静态页面是渲染好的正文,没有脚本,搜索进来的读者直接能读,页面上有回到阅读器(目录、搜索、深色模式、面试题练习)的链接。 +// 用法:node static_notes.cjs <站点地址>,输出生成的页面数;Markdown 用和 Docsify 4.13.1 同一个大版本的 marked 渲染, +// 标题的 id 按 Docsify 的规则生成(与 site_assets.py 的 heading_slug 相同),网站上的小节链接在静态页面上同样可用。 +'use strict'; +const fs = require('fs'); +const path = require('path'); +const marked = require('./vendor/marked.min.js'); + +const PUNCTUATION = /[\u2000-\u206f\u2e00-\u2e7f\\'!"#$%&()*+,./:;<=>?@[\]^`{|}~]/g; +function slugger() { + const counts = {}; + return function (html) { + let slug = html.replace(/<[^>]+>/g, '').trim().toLowerCase().replace(PUNCTUATION, ''); + slug = slug.replace(/\s/g, '-').replace(/-+/g, '-').replace(/^(\d)/, '_$1'); + const count = counts[slug] || 0; + counts[slug] = count + 1; + return slug + (count ? '-' + count : ''); + }; +} +function escapeHtml(text) { + return String(text).replace(/[&<>"']/g, c => ({ '&': '&', '<': '<', '>': '>', '"': '"', "'": ''' }[c])); +} +function plain(html) { + return html.replace(/<[^>]+>/g, '').replace(/ /g, ' ').replace(/&/g, '&').replace(/</g, '<').replace(/>/g, '>') + .replace(/"/g, '"').replace(/'/g, "'").replace(/\s+/g, ' ').trim(); +} +const route = name => name.split('/').map(encodeURIComponent).join('/'); + +// 一级标题后面只有页内链接的列表是文首目录,折叠起来,和网站上一样 +function foldToc(html) { + const head = html.match(/<\/h1>\s*