Skip to content

🗂️Generate Github demo pages TOC, normalize html for SEO, build sitemap for SEO...

License

Notifications You must be signed in to change notification settings

vivaxy/github-pages-scripts

Repository files navigation

@vivaxy/github-pages-scripts

Build Status NPM Version NPM Downloads MIT License Standard Version Codecov

Usage

Run in standalone

npx @vivaxy/github-pages-scripts

Install and run with pre-commit hook

  1. npm install @vivaxy/github-pages-scripts husky --save-dev
  2. Edit package.json
{
+ "husky": {
+   "hooks": {
+     "pre-commit": "gps toc && gps sitemap && git add ."
+   }
+ }
}

Config

readme-prefix

Readme prefix string.

readme-suffix

Readme suffix string.

link-prefix

Site root path. As the link prefix.

Project created by create-n.