Gitit Bigger 相关设置

Gitit Bigger 提供一定程度的配置，你可以通过在 templates/page_more_scripts.st 里定义 BIGGER_SETTINGS_APPEND 对象来覆盖默认配置。

默认配置：

配置方式：

  1. 创建 templates/page_more_scripts.st 文件（该文件没有被加入到 gitit-bigger 的仓库里）；
  2. 在 templates/page_more_scripts.st 里的 JavaScript 里，按规则定义 BIGGER_SETTINGS_APPEND 以覆盖默认配置
  3. 重启 Gitit。对所有静态文件的更新，都必须要重启 gitit 服务才能看到效果；可运行 ./run/run.sh restart 来重启；
  4. 此外：
  5. templates/page_more_scripts.st 是一个 HTML 文件，你可以做其他任何能做的事情；

默认配置说明

主要内容：

  • ace 编辑器相关
    • 默认启用；
    • markdown 相关
      • 默认启用；
      • 快捷键：默认启用；
      • 快捷键函数：默认为 Gitit Bigger 提供的；
    • styles: 一个对象，键名都必须是 DOM 方法；
  • MathJax 数学公式插件相关
    • 默认启用；
    • 在 mathjax.exclude 数据组的页面，MathJax 插件将不会被引入；
  • highlightjs 代码高亮插件相关
    • 默认启用—因我发现 Gitit 自己的高亮机制需要不少其他处理， highlightjs 比较省事；
    • theme: 即 /static/js/highlight/styles/ 目录下的某个文件名，不带扩展。比如： monokai_sublime
  • 其他细节
    • google_analytics_id: 如果值不为空，将会引入 Google Analytics；值举例：UA-19890535-1
    • 新窗口打开 http 链接：默认关闭；

示例

  1. <script type="text/javascript" src="/path/to/js/file.js"></script>
  3. <style type="text/css">
  4.   color: red;
  5. </style>
  7. <script>
  8. // more js scripts here
  9. BIGGER_SETTINGS_APPEND = {
  10.     "ace":{
  11.         "styles":{
  12.             "fontSize":"15px"
  13.         }
  14.     },
  15.     "mathjax":{
  16.         "enable":false,
  17.     }
  18. }
  19. </script>

默认配置源码

  1. // Base settings.
  2. // You can override base config by using a BIGGER_SETTINGS_APPEND object.
  3. // Waring, override by "BIGGER_SETTINGS_APPEND" object.
  4. BIGGER_SETTINGS_BASE = {
  5.     // ace editor settings
  6.     // more about ace editor: https://ace.c9.io
  7.     "ace": {
  8.         // switch
  9.         "enable": true,
  11.         // ace editor, core settings.
  12.         "setTheme": "ace/theme/github", // theme, and below are ace settings
  13.         "setMode": "ace/mode/markdown", // editor mode, default ,will be override by markdowns.enable
  14.         "setShowPrintMargin": false,
  15.         "setShowGutter": false,
  16.         "setUseWrapMode": true,
  17.         "setUseSoftTabs": true, // instend tabs with spaces
  19.         // markdown reloadted,
  20.         "markdowns": {
  21.             "enable": true, // enable markdown mode
  22.             "shortcuts": true, // enable markdown shortcuts
  23.             "shortcutsFunc": setShortcuts // custome shortcut function
  24.         },
  25.         // styles: document.style.ATTRS, case-sensitive.
  26.         "styles": {
  27.             "fontSize": "13px",
  28.             "fontWight": "normal",
  29.             "fontColor": "#333"
  30.         }
  31.     },
  32.     "mathjax": {
  33.         "enable": true,
  34.         // "path": "https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML",
  35.         "path": "http://cdn.bootcss.com/mathjax/2.5.3/MathJax.js?config=TeX-AMS-MML_HTMLorMML",
  36.         "exclude": ["/_search", "/_index", "/_category", "/_upload", "/_activity", "/_register", "/_login",
  37.             "/_delete", "/_diff"
  38.         ]
  39.     },
  41.     // highlightjs
  42.     // If your server can't highlightjs the syntax, you can use highlightjs
  43.     // default: false
  44.     // more about highlightjs: https://highlightjs.org/
  45.     "highlightjs": {
  46.         "enable": true,
  47.         "theme": "monokai_sublime"
  48.     },
  49.     "google_analytics_id": "",
  50.     "target_blank": false,
  51. }