/*@jsxRuntime automatic @jsxImportSource react*/ const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0]; function _createMdxContent(props) { const _components = Object.assign({ section: "section", h2: "h2", pre: "pre", code: "code", p: "p", ul: "ul", li: "li", a: "a" }, props.components), {Property} = _components; if (!Property) _missingMdxReference("Property", true); return _jsxs(_Fragment, { children: [_jsxs(_components.section, { id: "usage", children: [_jsx(_components.h2, { id: "usage", children: "Usage" }), "\n", _jsx(_components.pre, { raw: "@docs.page/cli check [path]\n", language: "shellscript", html: "

@docs.page/cli check [path]\n

", children: _jsx(_components.code, { className: "language-bash", children: "@docs.page/cli check [path]\n" }) }), "\n", _jsx(_components.p, { children: "The command current performs the following checks:" }), "\n", _jsxs(_components.ul, { children: ["\n", _jsx(_components.li, { children: "Broken Links: Checks markdown content for any broken relative links." }), "\n", _jsxs(_components.li, { children: ["Missing Assets: Checks markdown content for any local ", _jsx(_components.a, { href: "/assets", children: "assets" }), " that are missing."] }), "\n"] }), "\n"] }), _jsxs(_components.section, { id: "arguments", children: [_jsx(_components.h2, { id: "arguments", children: "Arguments" }), "\n", _jsxs(Property, { name: "path", type: "string", optional: true, children: [_jsx(_components.p, { children: "The path to the directory to check for issues. This should be the path to the root of the project." }), _jsx(_components.p, { children: "Defaults to the current directory." }), _jsx(_components.pre, { raw: "@docs.page/cli check my-project\n", language: "text", html: "

@docs.page/cli check my-project\n

", children: _jsx(_components.code, { children: "@docs.page/cli check my-project\n" }) })] })] })] }); } function MDXContent(props = {}) { const {wrapper: MDXLayout} = props.components || ({}); return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, { children: _jsx(_createMdxContent, props) })) : _createMdxContent(props); } return { default: MDXContent }; function _missingMdxReference(id, component) { throw new Error("Expected " + (component ? "component" : "object") + " `" + id + "` to be defined: you likely forgot to import, pass, or provide it."); }

CLI

check

Usage

Arguments

On this page