Configurations and Settings
Blackbeard includes smart defaults out-of-the-box. But if you want to customize things, you can adjust many of the options and settings.
To add your configuration settings:
0. Log in to the API Control Center.
0. To to `Manage > Portal` and click on `Portal Settings`.
0. Add your settings under the `Inline Javascript` section in the `Body JavaScript` field.
0. Remove any pre-existing content from `Footer Copyright`.
## The Configuration Settings
Default values are shown below.
```js
/**
* Ajax page loads
* Whether to load pages async or with a page reload
*/
// If true, use Ajax
portalOptions.ajax = true;
// Selectors to ignore if clicked.
// Accepts any valid CSS selector.
// Use comma separated list for multiple selectors.
portalOptions.ajaxIgnore = null;
// Text to display in title while loading page
portalOptions.ajaxLoading = 'Loading...';
/**
* Active Page Class
* Class for links that point to the current page. This is applied to links in the primary, secondary, and user navigation menus, as well as the documentation submenu on documentation pages.
*/
portalOptions.currentPageClass = 'current-page';
/**
* Blog Excerpt Length
* How long the excerpts on the "All Blog Posts" pages should be.
*/
portalOptions.excerptLength = 250;
/**
* Favicon
* Add a favicon/tab icon for your Portal.
*/
// If true, inject a favicon
portalOptions.favicon = false;
// The favicon URL
portalOptions.faviconURL = '/files/favicon.ico';
// The favicon sizes
portalOptions.faviconSizes = '16x16 32x32';
/**
* Logo
* Add a custom logo. Accepts any markup as a string (``, ``, etc.).
*/
portalOptions.logo = null;
/**
* Markdown
* If true, enable markdown on docs and custom pages.
*/
portalOptions.markdown = true;
/**
* Tooltips
* If true, activate mashtip tooltips on certain Account page elements.
*/
portalOptions.mashtips = true;
/**
* Password Strength
* If true, provide a password strength indicator on registration and password change pages.
*/
portalOptions.passwordStrength = true;
/**
* Responsive Design
* If true, include the viewport resizing meta tag required for responsively designed sites.
*/
portalOptions.responsive = true;
```
Docs Navigation
- API Documentation Portal
- IO Docs Definition
- Mashery API Documentation
- Mashery 3.0 API Guide
- Mashery 2.0 API Guide
- OAuth Supporting Methods
- Examples
- JSON RPC
- Authentication
- API Objects
- Fetching Objects
- Query Language
- Creating Objects
- Updating Objects
- Validating Fields
- Deleting Objects
- Applications
- General Object Methods
- Members
- Packages
- Plans
- Package Keys
- Keys
- Developer Classes
- Services
- Roles
- Mashery 2.0 Reporting API Guide
- Event Trigger API
- Differences between Roles and Portal Access Groups
- Managing a Portal Access Group Using Mashery V2 or V3 API
- Mashery Reporting Event Post API Guide
- Tips and Tricks
- Your Portal
- API Traffic Manager
- I/O Docs WSDL requirements