@docusaurus/core/lib/server/site.d.ts

Easy to Maintain Open Source Documentation Websites

/**
 * Copyright (c) Facebook, Inc. and its affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
import type { LoadContext, Props, PluginIdentifier } from '@docusaurus/types';
export type LoadContextParams = {
    /** Usually the CWD; can be overridden with command argument. */
    siteDir: string;
    /** Custom output directory. Can be customized with `--out-dir` option */
    outDir?: string;
    /** Custom config path. Can be customized with `--config` option */
    config?: string;
    /** Default is `i18n.defaultLocale` */
    locale?: string;
    /**
     * `true` means the paths will have the locale prepended; `false` means they
     * won't (useful for `yarn build -l zh-Hans` where the output should be
     * emitted into `build/` instead of `build/zh-Hans/`); `undefined` is like the
     * "smart" option where only non-default locale paths are localized
     */
    localizePath?: boolean;
};
export type LoadSiteParams = LoadContextParams & {
    isReload?: boolean;
};
export type Site = {
    props: Props;
    params: LoadSiteParams;
};
/**
 * Loading context is the very first step in site building. Its params are
 * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n
 * context (which includes code translations). The `LoadContext` will be passed
 * to plugin constructors.
 */
export declare function loadContext(params: LoadContextParams): Promise<LoadContext>;
/**
 * This is the crux of the Docusaurus server-side. It reads everything it needs—
 * code translations, config file, plugin modules... Plugins then use their
 * lifecycles to generate content and other data. It is side-effect-ful because
 * it generates temp files in the `.docusaurus` folder for the bundler.
 */
export declare function loadSite(params: LoadSiteParams): Promise<Site>;
export declare function reloadSite(site: Site): Promise<Site>;
export declare function reloadSitePlugin(site: Site, pluginIdentifier: PluginIdentifier): Promise<Site>;