marko-starter is deprecated, check out @marko/serve for an updated zero config Marko setup!
This module is used for easily publishing marko-starter websites to GitHub pages.
npm install @marko/starter-gh-pages
const markoPages = require("@marko/starter-gh-pages");
(async function () {
await markoPages.publish({
...
})
});
Usage: marko-starter-gh-pages [options]
Examples:
With a commit message:
marko-starter-gh-pages -m "Hello this is my commit!"
With redirects:
marko-starter-gh-pages -e /docs/home /docs /admin/home /admin
Options:
--build-dir -b Directory where the built files will reside. Defaults to "./dist" [string]
--project-dir -p Directory of the project.js file. Defaults to "process.cwd()" [string]
--base-url -u Base URL for the page (e.g. /my-project) [string]
--redirects -e List of URLs to redirect and where to redirect to (--redirects /docs/home /docs) [string]
--branch -B Branch to push to (defaults to "gh-pages") [string]
--dest -d The folder to publish to do n the destination branch. Defaults to the root of the repository. [string]
--repo -r Repository to push to. Defaults to the current working directory with "origin" remote. [string]
--remote -R Name of the remote to push to (defaults to "origin") [string]
--tag -t Git tag to create with the build. None created if not used. [string]
--message -m Commit message (defaults to "Updates") [string]
--help -h Show all properties [string]