chappe/res/config/common.json

Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.

{
  "LANGS" : [
    "en"
  ],

  "URLS" : {
    "CRISP_WEB" : "https://crisp.chat/"
  },

  "LIBRARIES" : {
    "JAVASCRIPTS" : [
      "console/console.js",
      "cookies/src/cookies.js",
      "cash/dist/cash.js",
      "minisearch/dist/umd/index.js",
      "prism.js/prism.js"
    ],

    "STYLESHEETS" : [
      "reset.css/reset.css"
    ]
  },

  "SOURCES" : {
    "TEMPLATES" : [
      "home/index.jade",
      "not_found/index.jade"
    ],

    "JAVASCRIPTS" : [
      "common/common.js"
    ],

    "STYLESHEETS" : [
      "common/common.sass",
      "home/home.sass",
      "guides/guides.sass",
      "references/references.sass",
      "changes/changes.sass",
      "not_found/not_found.sass"
    ]
  },

  "FORMAT" : {
    "DESCRIPTION" : {
      "TRUNCATE" : 140
    },

    "DATES" : {
      "LOCALE_DATE_STRING" : {
        "AREA"    : "en-US",

        "OPTIONS" : {
          "year"  : "numeric",
          "month" : "long",
          "day"   : "numeric"
        }
      }
    }
  },

  "COLORS" : {
    "BADGES" : {
      "HTTP" : {
        "head"   : "blue",
        "get"    : "blue",
        "post"   : "green",
        "put"    : "yellow",
        "patch"  : "yellow",
        "delete" : "red"
      }
    }
  },

  "SEARCH" : {
    "INDEX" : "search/index.json",

    "OPTIONS" : {
      "BASE" : {
        "fields"      : [
          "title",
          "path",
          "summary"
        ],

        "storeFields" : [
          "id",
          "path",
          "title",
          "summary"
        ]
      },

      "QUERY" : {
        "searchOptions" : {
          "prefix"  : true,
          "fuzzy"   : 0.15,

          "boost"   : {
            "title"   : 6,
            "path"    : 4,
            "summary" : 1
          },

          "weights" : {
            "fuzzy"  : 0.5,
            "prefix" : 0.25
          }
        }
      }
    }
  }
}