Class: Hikaru

hikaru~Hikaru(optsopt) → {Hikaru}

new Hikaru(optsopt) → {Hikaru}

Hikaru main class.

Parameters:
Name Type Attributes Description
opts Object <optional>
Properties
Name Type Attributes Default Description
debug Boolean <optional>
 false

Enable debug output for logger.
color Boolean <optional>
 true

Enable colored output for logger.
draft Boolean <optional>

Build drafts.
siteConfig String <optional>

Alternative site config path.
themeConfig String <optional>

Alternative theme config path.
ip String <optional>
 localhost

Alternative listening IP address for router.
port Number <optional>
 2333

Alternative listening port for router.
Properties:
Name Type Description
logger Logger
watcher Watcher
router Router
renderer Renderer
processor Processor
generator Generator
decorator Decorator
translator Translator
types Object
utils Object
opts Object
site Site
Source:
Returns:
Type
Hikaru

Methods

(async) build(siteDir)

Build and write docs from srcs.

Parameters:
Name Type Description
siteDir String

Working site dir.
Source:

clean(siteDir)

Clean a Hikaru site's built docs.

Parameters:
Name Type Description
siteDir String

Working site dir.
Source:

init(siteDir)

Create a Hikaru site dir with needed files.

Parameters:
Name Type Description
siteDir String

Working site dir.
Source:

(async) serve(siteDir)

Build and serve docs with a HTTP server from srcs.

Parameters:
Name Type Description
siteDir String

Working site dir.
Source: