Octri

github docs

Lists the repository's MDX and Markdown files with their sizes, and shows whether page sync is on, which folder it watches, how many pages are linked to files, and the last sync error, if any. Octri never writes pages back to your repository. See GitHub sync.

bash
octri github docs [status | pull [path…] | sync <on|off>]

octri github docs pull [path…]

Writes the repository's docs files to disk, keeping their folders. It only writes files, and doesn't change any page.

Arguments

[path…]stringdefault: every file `github docs` lists

The files to pull.

Flags

--out <dir>pathdefault: the current folder

Where to write them.

octri github docs sync <on|off>

With page sync on, a push rewrites the drafts of the pages linked to the changed files. Readers see nothing until you publish.

Arguments

<on|off>stringrequired

Whether to sync on push.

Flags

--folder <folder>stringdefault: the folder already set

Only files under this folder, such as docs/.

Examples

Pull every docs file

bash
octri github docs pull --out ./docs-from-repo