Skip to content

Commit fb422a7

Browse files
committed
update README
1 parent ec28a96 commit fb422a7

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@ This plugin provides *Project Pages* functionality for
66

77
## User guide
88

9-
This plugin can serve static files from a special orphan branch called `gb-pages` under
10-
`<base url>/<user>/<project>/pages/`. (fallback to `gh-pages` if it exists)
9+
This plugin serves static files directly from one of the following
10+
place:
11+
12+
- `gb-pages` branch (with fallback to `gh-pages` to be compatible with
13+
github, this is the default)
14+
- `master` branch
15+
- `docs` folder under `master` branch
1116

1217
### Quick start
1318

14-
- create an orphan branch called `gb-pages` using `git checkout --orphan gb-pages && git rm -f $(git ls-files)`
19+
- create directory or branch if necessary (eg. create an orphan branch called `gb-pages`: `git checkout --orphan gb-pages && git rm -f $(git ls-files)`)
1520
- create a static site under this branch. E.g. `echo '<h1>hello, world</h1>' > index.html` to create a simple file.
1621
- commit && push to gitbucket this orphan branch
1722
- open the browser and point to `<your repo url>/pages`
@@ -29,8 +34,9 @@ site generators ([jekyll](http://jekyllrb.com/), [hugo](https://gohugo.io/), etc
2934

3035
| pages version | gitbucket version |
3136
| :---: | :---: |
32-
| 1.0 | 4.11 |
33-
| 0.9 | 4.9, 4.10 |
37+
| 1.1 | 4.11 |
38+
| 1.0 | 4.10 |
39+
| 0.9 | 4.9 |
3440
| 0.8 | 4.6 |
3541
| 0.7 | 4.3 ~ 4.6 |
3642
| 0.6 | 4.2.x |

0 commit comments

Comments
 (0)