Skip to content

Commit 91ea6ae

Browse files
committed
Update README.md
1 parent 2b9240e commit 91ea6ae

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11

22
# Gitbucket-Pages-Plugin [![Gitter](https://img.shields.io/gitter/room/gitbucket/gitbucket.js.svg?style=flat-square)](https://gitter.im/gitbucket/gitbucket) [![Travis](https://img.shields.io/travis/yaroot/gitbucket-pages-plugin.svg?style=flat-square)](https://travis-ci.org/yaroot/gitbucket-pages-plugin)
33

4-
This plugin provides *Project Pages* for
5-
[GitBucket](https://github.com/gitbucket/gitbucket).
4+
This plugin provides *Project Pages* functionality for
5+
[GitBucket](https://github.com/gitbucket/gitbucket) based repositories.
66

77
## User documentation
88

9-
This plugin would serve static file under `gh-pages` branch under
9+
This plugin can serve static files from a special orphan branch called `gh-pages` under
1010
`<base url>/<user>/<project>/pages/`.
1111

1212
### Quick start
1313

14-
- checkout orphan branch via `git checkout --orphan && git rm -f $(git ls-files)`
15-
- `echo '<h1>hello, world</h1>' > index.html`
16-
- commit && push to gitbucket
17-
- open browser and point to `<your repo url>/pages`
14+
- create an orphan branch called `gh-pages` using `git checkout --orphan gh-pages && git rm -f $(git ls-files)`
15+
- create a static site under this branch. E.g. `echo '<h1>hello, world</h1>' > index.html` to create a simple file.
16+
- commit && push to gitbucket this orphan branch
17+
- open the browser and point to `<your repo url>/pages`
1818

19-
**note**: this plugin won't render markdown for you, pre-build the
20-
site or just use wiki
19+
**Note**: This plugin won't render markdown content. To render markdown content, use the wiki or one of the many static
20+
site generators.
2121

2222
## Installation
2323

2424
- download from [releases](https://github.com/yaroot/gitbucket-pages-plugin/releases)
25-
- move the jar file to `<gitbucket_home>/plugins/` (`gitbucket_home` defaults to `~/.gitbucket`)
25+
- copy the jar file to `<GITBUCKET_HOME>/plugins/` (Note that `GITBUCKET_HOME` defaults to `~/.gitbucket`)
2626
- restart gitbucket and enjoy
2727

2828
## Versions
@@ -38,8 +38,8 @@ site or just use wiki
3838

3939
## Security (panic mode)
4040

41-
To prevent XSS, one must use two different domain to host pages and
42-
gitbucket. Below is a working example of nginx config to achieve that.
41+
To prevent XSS, one must use two different domains to host the pages and
42+
Gitbucket itself. Below is a working example of nginx configuration to achieve that.
4343

4444
```
4545
server {

0 commit comments

Comments
 (0)