{ "attributes": { "id": "configuration", "linkText": "Configuring Fountainhead", "title": "Configuring Fountainhead" }, "body": "

Fountainhead has sane defaults for all configuration options. Standard apps/addons\nshould be able to generate documentation files and use Fountainhead without any\nconfiguration. When needed though, Fountainhead can be customized as desired using\na fountainhead.js file.

\n{{#fountainhead-header tagName=\"h2\" elementId=\"fountainhead.js-configuration-options\"}}fountainhead.js Configuration Options{{/fountainhead-header}}\n
fountainhead.js
\n
/*\n * Fountainhead Default Configurations\n * These are the configuration defaults, they can be overwritten as needed\n */\nmodule.exports = {\n  // Sets url for repository link in top left of API page\n  repository: ''\n  // Generate data files before builds for live reloading\n  liveEdit: true,\n  // Import Fountainhead styles into vendor.css\n  includeVendorStyles: true,\n  // Set to true to suppress error logging during data file generation\n  quiet: false,\n  // Fountainhead custom tags not recognized by YUIDoc\n  whiteListTags: ['passed', 'closure', 'action'],\n  // Set custom logo path\n  logo: ''\n  // Directories to parse for API documentation\n  entry: ['app'],\n  // Paths to guide files\n  guides: [],\n  // Output directory and filename for master data set\n  output: {\n    filename: 'fountainhead-data.json',\n    path: path.resolve('docs')\n  },\n  // Automatically set to consuming application's locationType, but can\n  // be explicitly specified (sets internal link id target types between\n  // query params and hash fragments)\n  locationType: locationType\n};\n
\n

{{#fountainhead-alert canDismiss=false brand='info'}}\n{{fountainhead-svg svgId='info'}} All paths are resolved using path.resolve,\nmeaning that either a relative path or paths starting with ./ will resolve to\nyour project's root directory.\n{{/fountainhead-alert}}

\n{{#fountainhead-header tagName=\"h2\" elementId=\"environment-specific-configuration\"}}Environment Specific Configuration{{/fountainhead-header}}\n

You can export a function from fountainhead.js that will receive the build\nenvironment as a parameter if you need environment specific configurations:

\n
fountainhead.js
\n
// EG: Include only your app files for production documentation. In dev builds\n// include internal dev utilities documentation\nmodule.exports = env => {\n  entry: env === 'production' ? ['app'] : ['app', 'dev-utilities']\n}\n
\n{{#fountainhead-header tagName=\"h2\" elementId=\"fountainhead-service-namespace\"}}Fountainhead Service Namespace{{/fountainhead-header}}\n

You can override the root namespace that all Fountainhead requests use by setting\nthe {{c-l class='Fountainhead' item='apiNamespace'}}. The default value is /docs.

\n
app.js
\n
import Fountainhead from 'ember-fountainhead/services/fountainhead';\n\nFountainhead.reopen({ apiNamespace: '/special-namespace/v1/' });\n
\n

The meta request would now use url: /special-namespace/v1/meta.json

\n", "frontmatter": "id: configuration\nlinkText: Configuring Fountainhead\ntitle: Configuring Fountainhead", "id": "configuration", "type": "guides" }