From f2770f2aae8e55428c29ece3214c1d59511382e0 Mon Sep 17 00:00:00 2001 From: Victor Pogor Date: Wed, 11 Nov 2020 21:00:55 +0000 Subject: [PATCH] chore: cleaned comments in files fix #24 --- exampleSite/assets/css/_custom.scss | 1 - exampleSite/assets/css/_override.scss | 1 - exampleSite/config.toml | 133 +------------------------- 3 files changed, 4 insertions(+), 131 deletions(-) diff --git a/exampleSite/assets/css/_custom.scss b/exampleSite/assets/css/_custom.scss index 37edf904..e2ea45b0 100644 --- a/exampleSite/assets/css/_custom.scss +++ b/exampleSite/assets/css/_custom.scss @@ -1,4 +1,3 @@ // ============================== // Custom style -// 自定义样式 // ============================== diff --git a/exampleSite/assets/css/_override.scss b/exampleSite/assets/css/_override.scss index c37b4ec3..305de3cc 100644 --- a/exampleSite/assets/css/_override.scss +++ b/exampleSite/assets/css/_override.scss @@ -1,4 +1,3 @@ // ============================== // Override Variables -// 覆盖变量 // ============================== diff --git a/exampleSite/config.toml b/exampleSite/config.toml index 7ef785af..ee23c99f 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,26 +1,19 @@ baseURL = "https://example.com" # [en, zh-cn, fr, pl, ...] determines default content language -# [en, zh-cn, fr, pl, ...] 设置默认的语言 defaultContentLanguage = "en" # theme -# 主题 theme = "CodeIT" # themes directory -# 主题目录 themesDir = "../.." # website title -# 网站标题 title = "CodeIT" # whether to use robots.txt -# 是否使用 robots.txt enableRobotsTXT = true # whether to use git commit log -# 是否使用 git 信息 enableGitInfo = true # whether to use emoji code -# 是否使用 emoji 代码 enableEmoji = true # Ignore get JSON errors. @@ -625,199 +618,137 @@ ignoreErrors = ["error-remote-getjson"] [params] # CodeIT theme version - # CodeIT 主题版本 version = "0.2.X" # site default theme ("light", "dark", "auto") - # 网站默认主题 ("light", "dark", "auto") defaultTheme = "auto" # public git repo url only then enableGitInfo is true - # 公共 git 仓库路径，仅在 enableGitInfo 设为 true 时有效 gitRepo = "https://github.com/sunt-programator/CodeIT" # which hash function used for SRI, when empty, no SRI is used ("sha256", "sha384", "sha512", "md5") - # 哪种哈希函数用来 SRI, 为空时表示不使用 SRI ("sha256", "sha384", "sha512", "md5") fingerprint = "" # date format - # 日期格式 dateFormat = "2006-01-02" # website images for Open Graph and Twitter Cards - # 网站图片, 用于 Open Graph 和 Twitter Cards images = ["/logo.png"] # Header config - # 页面头部导航栏配置 [params.header] # desktop header mode ("fixed", "normal", "auto") - # 桌面端导航栏模式 ("fixed", "normal", "auto") desktopMode = "fixed" # mobile header mode ("fixed", "normal", "auto") - # 移动端导航栏模式 ("fixed", "normal", "auto") mobileMode = "auto" # Header title config - # 页面头部导航栏标题配置 [params.header.title] # URL of the LOGO - # LOGO 的 URL logo = "" # title name - # 标题名称 name = "CodeIT" # you can add extra information before the name (HTML format is supported), such as icons - # 你可以在名称 (允许 HTML 格式) 之前添加其他信息, 例如图标 pre = "" # you can add extra information after the name (HTML format is supported), such as icons - # 你可以在名称 (允许 HTML 格式) 之后添加其他信息, 例如图标 post = "" # whether to use typeit animation for title name - # 是否为标题显示打字机动画 typeit = false # Footer config - # 页面底部信息配置 [params.footer] enable = true # Custom content (HTML format is supported) - # 自定义内容 (支持 HTML 格式) custom = '' # whether to show Hugo and theme info - # 是否显示 Hugo 和主题信息 hugo = true # whether to show copyright info - # 是否显示版权信息 copyright = true # whether to show the author - # 是否显示作者 author = true # site creation time - # 网站创立年份 since = 2019 # ICP info only in China (HTML format is supported) - # ICP 备案信息，仅在中国使用 (支持 HTML 格式) icp = "" # license info (HTML format is supported) - # 许可协议信息 (支持 HTML 格式) license= 'CC BY-NC 4.0' # Section (all posts) page config - # Section (所有文章) 页面配置 [params.section] # special amount of posts in each section page - # section 页面每页显示文章数量 paginate = 20 # date format (month and day) - # 日期格式 (月和日) dateFormat = "01-02" # amount of RSS pages - # RSS 文章数目 rss = 10 # List (category or tag) page config - # List (目录或标签) 页面配置 [params.list] # special amount of posts in each list page - # list 页面每页显示文章数量 paginate = 20 # date format (month and day) - # 日期格式 (月和日) dateFormat = "01-02" # amount of RSS pages - # RSS 文章数目 rss = 10 # Page config - # 文章页面配置 [params.page] # whether to hide a page from home page - # 是否在主页隐藏一篇文章 hiddenFromHomePage = false # whether to hide a page from search results - # 是否在搜索结果中隐藏一篇文章 hiddenFromSearch = false # whether to enable twemoji - # 是否使用 twemoji twemoji = false # whether to enable lightgallery - # 是否使用 lightgallery lightgallery = false # whether to enable the ruby extended syntax - # 是否使用 ruby 扩展语法 ruby = true # whether to enable the fraction extended syntax - # 是否使用 fraction 扩展语法 fraction = true # whether to enable the fontawesome extended syntax - # 是否使用 fontawesome 扩展语法 fontawesome = true # whether to show link to Raw Markdown content of the content - # 是否显示原始 Markdown 文档内容的链接 linkToMarkdown = true # whether to show the full text content in RSS - # 是否在 RSS 中显示全文内容 rssFullText = false # Table of the contents config - # 目录配置 [params.page.toc] # whether to enable the table of the contents - # 是否使用目录 enable = true # whether to keep the static table of the contents in front of the post - # 是否保持使用文章前面的静态目录 keepStatic = false # whether to make the table of the contents in the sidebar automatically collapsed - # 是否使侧边目录自动折叠展开 auto = true # Code config - # 代码配置 [params.page.code] # whether to show the copy button of the code block - # 是否显示代码块的复制按钮 copy = true # the maximum number of lines of displayed code by default - # 默认展开显示的代码行数 maxShownLines = 10 # KaTeX mathematical formulas config (KaTeX https://katex.org/) - # KaTeX 数学公式配置 (KaTeX https://katex.org/) [params.page.math] enable = false # default block delimiter is $$ ... $$ and \\[ ... \\] - # 默认块定界符是 $$ ... $$ 和 \\[ ... \\] blockLeftDelimiter = "" blockRightDelimiter = "" # default inline delimiter is $ ... $ and \\( ... \\) - # 默认行内定界符是 $ ... $ 和 \\( ... \\) inlineLeftDelimiter = "" inlineRightDelimiter = "" # KaTeX extension copy_tex - # KaTeX 插件 copy_tex copyTex = true # KaTeX extension mhchem - # KaTeX 插件 mhchem mhchem = true # Mapbox GL JS config (Mapbox GL JS https://docs.mapbox.com/mapbox-gl-js) - # Mapbox GL JS 配置 (Mapbox GL JS https://docs.mapbox.com/mapbox-gl-js) [params.page.mapbox] # access token of Mapbox GL JS - # Mapbox GL JS 的 access token accessToken = "pk.eyJ1IjoiZGlsbG9uenEiLCJhIjoiY2s2czd2M2x3MDA0NjNmcGxmcjVrZmc2cyJ9.aSjv2BNuZUfARvxRYjSVZQ" # style for the light theme - # 浅色主题的地图样式 lightStyle = "mapbox://styles/mapbox/light-v10?optimize=true" # style for the dark theme - # 深色主题的地图样式 darkStyle = "mapbox://styles/mapbox/dark-v10?optimize=true" # whether to add NavigationControl (https://docs.mapbox.com/mapbox-gl-js/api/#navigationcontrol) - # 是否添加 NavigationControl (https://docs.mapbox.com/mapbox-gl-js/api/#navigationcontrol) navigation = true # whether to add GeolocateControl (https://docs.mapbox.com/mapbox-gl-js/api/#geolocatecontrol) - # 是否添加 GeolocateControl (https://docs.mapbox.com/mapbox-gl-js/api/#geolocatecontrol) geolocate = true # whether to add ScaleControl (https://docs.mapbox.com/mapbox-gl-js/api/#scalecontrol) - # 是否添加 ScaleControl (https://docs.mapbox.com/mapbox-gl-js/api/#scalecontrol) scale = true # whether to add FullscreenControl (https://docs.mapbox.com/mapbox-gl-js/api/#fullscreencontrol) - # 是否添加 FullscreenControl (https://docs.mapbox.com/mapbox-gl-js/api/#fullscreencontrol) fullscreen = true # Social share links in post page - # 文章页面的分享信息设置 [params.page.share] enable = true Twitter = true @@ -848,18 +779,14 @@ ignoreErrors = ["error-remote-getjson"] Trello = false Mix = false # Comment config - # 评论系统设置 [params.page.comment] enable = true # Disqus comment config (https://disqus.com/) - # Disqus 评论系统设置 (https://disqus.com/) [params.page.comment.disqus] enable = false # Disqus shortname to use Disqus in posts - # Disqus 的 shortname，用来在文章中启用 Disqus 评论系统 shortname = "" # Gitalk comment config (https://github.com/gitalk/gitalk) - # Gitalk 评论系统设置 (https://github.com/gitalk/gitalk) [params.page.comment.gitalk] enable = false owner = "" @@ -867,7 +794,6 @@ ignoreErrors = ["error-remote-getjson"] clientId = "" clientSecret = "" # Valine comment config (https://github.com/xCss/Valine) - # Valine 评论系统设置 (https://github.com/xCss/Valine) [params.page.comment.valine] enable = true appId = "QGzwQXOqs5JOhN4RGPOkR2mR-MdYXbMMI" @@ -887,14 +813,8 @@ ignoreErrors = ["error-remote-getjson"] # located in "themes/CodeIT/assets/data/emoji/" directory # you can store your own data files in the same path under your project: # "assets/data/emoji/" - # emoji 数据文件名称, 默认是 "google.yml" - # ("apple.yml", "google.yml", "facebook.yml", "twitter.yml") - # 位于 "themes/CodeIT/assets/data/emoji/" 目录 - # 可以在你的项目下相同路径存放你自己的数据文件: - # "assets/data/emoji/" emoji = "" # Facebook comment config (https://developers.facebook.com/docs/plugins/comments) - # Facebook 评论系统设置 (https://developers.facebook.com/docs/plugins/comments) [params.page.comment.facebook] enable = false width = "100%" @@ -902,7 +822,6 @@ ignoreErrors = ["error-remote-getjson"] appId = "" languageCode = "" # Telegram comments config (https://comments.app/) - # Telegram comments 评论系统设置 (https://comments.app/) [params.page.comment.telegram] enable = false siteID = "" @@ -913,11 +832,9 @@ ignoreErrors = ["error-remote-getjson"] dislikes = false outlined = false # Commento comment config (https://commento.io/) - # Commento comment 评论系统设置 (https://commento.io/) [params.page.comment.commento] enable = false # Utterances comment config (https://utteranc.es/) - # Utterances comment 评论系统设置 (https://utteranc.es/) [params.page.comment.utterances] enable = false # owner/repo @@ -927,48 +844,38 @@ ignoreErrors = ["error-remote-getjson"] lightTheme = "github-light" darkTheme = "github-dark" # Third-party library config - # 第三方库配置 [params.page.library] [params.page.library.css] # someCSS = "some.css" - # located in "assets/" 位于 "assets/" - # Or 或者 + # located in "assets/" + # Or # someCSS = "https://cdn.example.com/some.css" [params.page.library.js] # someJavascript = "some.js" - # located in "assets/" 位于 "assets/" - # Or 或者 + # located in "assets/" + # Or # someJavascript = "https://cdn.example.com/some.js" # Page SEO config - # 页面 SEO 配置 [params.page.seo] # image URL - # 图片 URL images = [] # Publisher info - # 出版者信息 [params.page.seo.publisher] name = "xxxx" logoUrl = "/images/avatar.png" # TypeIt config - # TypeIt 配置 [params.typeit] # typing speed between each step (measured in milliseconds) - # 每一步的打字速度 (单位是毫秒) speed = 100 # blinking speed of the cursor (measured in milliseconds) - # 光标的闪烁速度 (单位是毫秒) cursorSpeed = 1000 # character used for the cursor (HTML format is supported) - # 光标的字符 (支持 HTML 格式) cursorChar = "|" # cursor duration after typing finishing (measured in milliseconds, "-1" means unlimited) - # 打字结束之后光标的持续时间 (单位是毫秒, "-1" 代表无限大) duration = -1 # Site verification code for Google/Bing/Yandex/Pinterest/Baidu - # 网站验证代码，用于 Google/Bing/Yandex/Pinterest/Baidu [params.verification] google = "" bing = "" @@ -977,83 +884,61 @@ ignoreErrors = ["error-remote-getjson"] baidu = "" # Site SEO config - # 网站 SEO 配置 [params.seo] # image URL - # 图片 URL image = "/images/Apple-Devices-Preview.png" # thumbnail URL - # 缩略图 URL thumbnailUrl = "/images/screenshot.png" # Analytics config - # 网站分析配置 [params.analytics] enable = false - # Google Analytics [params.analytics.google] id = "" # whether to anonymize IP - # 是否匿名化用户 IP anonymizeIP = true # Fathom Analytics [params.analytics.fathom] id = "" # server url for your tracker if you're self hosting - # 自行托管追踪器时的主机路径 server = "" # Cookie consent config - # Cookie 许可配置 [params.cookieconsent] enable = false # text strings used for Cookie consent banner - # 用于 Cookie 许可横幅的文本字符串 [params.cookieconsent.content] message = "" dismiss = "" link = "" # CDN config for third-party library files - # 第三方库文件的 CDN 设置 [params.cdn] # CDN data file name, disabled by default # ("jsdelivr.yml") # located in "themes/CodeIT/assets/data/cdn/" directory # you can store your own data files in the same path under your project: # "assets/data/cdn/" - # CDN 数据文件名称, 默认不启用 - # ("jsdelivr.yml") - # 位于 "themes/CodeIT/assets/data/cdn/" 目录 - # 可以在你的项目下相同路径存放你自己的数据文件: - # "assets/data/cdn/" data = "jsdelivr.yml" # Compatibility config - # 兼容性设置 [params.compatibility] # whether to use Polyfill.io to be compatible with older browsers - # 是否使用 Polyfill.io 来兼容旧式浏览器 polyfill = false # whether to use object-fit-images to be compatible with older browsers - # 是否使用 object-fit-images 来兼容旧式浏览器 objectFit = false # Markup related configuration in Hugo -# Hugo 解析文档的配置 [markup] # Syntax Highlighting (https://gohugo.io/content-management/syntax-highlighting) - # 语法高亮设置 (https://gohugo.io/content-management/syntax-highlighting) [markup.highlight] codeFences = true guessSyntax = true lineNos = true lineNumbersInTable = true # false is a necessary configuration (https://github.com/sunt-programator/CodeIT/issues/158) - # false 是必要的设置 (https://github.com/sunt-programator/CodeIT/issues/158) noClasses = false # Goldmark is from Hugo 0.60 the default library used for Markdown - # Goldmark 是 Hugo 0.60 以来的默认 Markdown 解析库 [markup.goldmark] [markup.goldmark.extensions] definitionList = true @@ -1065,39 +950,32 @@ ignoreErrors = ["error-remote-getjson"] typographer = true [markup.goldmark.renderer] # whether to use HTML tags directly in the document - # 是否在文档中直接使用 HTML 标签 unsafe = true # Table Of Contents settings - # 目录设置 [markup.tableOfContents] startLevel = 2 endLevel = 6 # Author config -# 作者配置 [author] name = "xxxx" email = "" link = "" # Sitemap config -# 网站地图配置 [sitemap] changefreq = "weekly" filename = "sitemap.xml" priority = 0.5 # Permalinks config (https://gohugo.io/content-management/urls/#permalinks) -# Permalinks 配置 (https://gohugo.io/content-management/urls/#permalinks) [Permalinks] # posts = ":year/:month/:filename" posts = ":filename" # Privacy config (https://gohugo.io/about/hugo-and-gdpr/) -# 隐私信息配置 (https://gohugo.io/about/hugo-and-gdpr/) [privacy] # privacy of the Google Analytics (replaced by params.analytics.google) - # Google Analytics 相关隐私 (被 params.analytics.google 替代) [privacy.googleAnalytics] # ... [privacy.twitter] @@ -1106,20 +984,17 @@ ignoreErrors = ["error-remote-getjson"] privacyEnhanced = true # Options to make output .md files -# 用于输出 Markdown 格式文档的设置 [mediaTypes] [mediaTypes."text/plain"] suffixes = ["md"] # Options to make output .md files -# 用于输出 Markdown 格式文档的设置 [outputFormats.MarkDown] mediaType = "text/plain" isPlainText = true isHTML = false # Options to make hugo output files -# 用于 Hugo 输出文档的设置 [outputs] home = ["HTML", "RSS", "JSON"] page = ["HTML", "MarkDown"]