File tree Expand file tree Collapse file tree 1 file changed +13
-4
lines changed Expand file tree Collapse file tree 1 file changed +13
-4
lines changed Original file line number Diff line number Diff line change 44This plugin provides * Project Pages* for
55[ GitBucket] ( https://github.com/gitbucket/gitbucket ) .
66
7- ## Notes
7+ ## User documentation
88
9- - ` <base url>/<user>/<project>/pages/ ` for branch ` gh-pages `
10- - no site generator will run
11- - have to manually add links to it
9+ This plugin would serve static file under ` gh-pages ` branch under
10+ ` <base url>/<user>/<project>/pages/ ` .
11+
12+ ### Quick start
13+
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 gitbuck
17+ - open browser and point to ` <your repo url>/pages `
18+
19+ ** note** : this plugin won't render markdown for you, pre-build the
20+ site or just use wiki
1221
1322## Installation
1423
You can’t perform that action at this time.
0 commit comments