Repository files navigation

This plugin providesProject Pages functionality forGitBucket based repositories.

This plugin serves static files directly from one of the followingplaces:

• gb-pages branch (with fallback togh-pages to be compatible withgithub, this is the default)
• master branch
• docs folder undermaster branch

• create a directory or branch if necessary (eg. create an orphan branch calledgb-pages:git checkout --orphan gb-pages && git rm -f $(git ls-files))
• create a static site under this branch. E.g.echo '<h1>hello, world</h1>' > index.html to create a simple file.
• commit && push to gitbucket this orphan branch
• open the browser and point to<your repo url>/pages

Note: This plugin won't render markdown content. To render markdown content, use the GitBucket Wiki functionality, or use one of the many static site generators (e.g.jekyll,hugo)

This plugin is bundled with newer version of GitBucket, for olderversion please follow the instruction below

• download fromreleases
• copy the jar file to<GITBUCKET_HOME>/plugins/ (GITBUCKET_HOME defaults to~/.gitbucket)
• enable it in plugin settings (you may need to restart gitbucket)

To prevent XSS, one must use two different domains to host the pages andGitbucket itself. Below is a working example of nginx configuration to achieve that.

server {    listen 80;    server_name git.local;    location ~ ^/([^/]+)/([^/]+)/pages/(.*)$ {        rewrite  ^/([^/]+)/([^/]+)/pages/(.*)$  http://doc.local/$1/$2/pages/$3  redirect;    }    location / {        proxy_pass http://127.0.0.1:8080;    }}server {    listen 80;    server_name doc.local;    location ~ ^/([^/]+)/([^/]+)/pages/(.*)$ {        proxy_pass http://127.0.0.1:8080;    }    location / {        return 403;    }}

• build byGitHub Actions