Docolatte(optsopt)
This class provides Docolatte specific features.
Constructor
new Docolatte(optsopt)
Parameters:
| Name | Type | Description |
|---|---|---|
optsopt
|
object |
Properties |
- License:
- Apache-2.0Copyright 2020 Satoshi Soma
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. - Source:
- lib/Docolatte.js, line 29
Methods
buildNav(members) → string
Builds navigation menus.
Parameters:
| Name | Type | Description |
|---|---|---|
members
|
object |
- Source:
- lib/Docolatte.js, line 268
Returns:
HTML
- Type:
- string
configure(configopt) → object
Configures this theme.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
configopt
|
object |
null
|
Config object to merge into the default |
- Source:
- lib/Docolatte.js, line 248
Returns:
Merged config object
- Type:
- object
replaceEmoji(str, conf) → string
Convert emojis in the provided string into proper format.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
str
|
string | String |
|||||||||
conf
|
object |
Properties
|
- Source:
- lib/Docolatte.js, line 348
- See:
- https://www.npmjs.com/package/emoji-js
Returns:
Modified string
- Type:
- string