Stars: 169
Forks: 18
Pull Requests: 8
Issues: 43
Watchers: 8
Last Updated: 2023-02-09 19:09:52
The static site generator for Grav CMS
License: Other
Languages: PHP
The ⚫ Blackhole Plugin is for Grav CMS.
Why Blackhole? Grav is a space term, so I think this plugin should follow suit. Time stops at the event horizon of a black hole, which is exactly what this plugin does to your website. It freezes it in a state. By Increasing gravity to infinity you get a static black hole, or in this case you generate a static html copy of your Grav website.
The simplest way to install this plugin is via the Grav Package Manager (GPM). From the root of your Grav install type:
bin/gpm install blackhole
If you can't use GPM you can manually install this plugin. Download the zip version of this repository and unzip it under /your/site/grav/user/plugins
, then rename the folder to blackhole
.
Absolute URLs must be enabled in Grav System Configuration.
The generate command can be used from the command line or directly in the Grav Admin Panel. Generate your static site. generate
can also be written as gen
or g
.
bin/plugin blackhole generate http://localhost/grav
Output URL --output-url
or -d
The URL of your static site. This determines the domain used in the absolute path of your links.
--output-url https://website.com
Output Path --output-path
or -p
The directory to which your static site will be written (relative to Grav root).
--output-path ../build
Routes --routes
or -r
Limit generation to a select list of page routes.
--routes home,about,about/contact
Use Sitemap --use-sitemap
or -m
Instead of listing all pages use a sitemap generated by the grav Sitemap plugin.
Usefull when your site has multiple languages and/or different URL extension (e.g. .html)
When this option is enabled the --routes option will be ignored.
--use-sitemap /sitemap
Simultaneous Limit --simultaneous
or -s
Determine how many files will generate at the same time (default: 10).
--simultaneous 10
Assets --assets
or -a
Copy assets to the output path.
Force --force
or -f
Overwrite previously generated files.
Verbose Mode --verbose-mode
Enable verbose mode.
Barry Anders |