tisseurs/web
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refresh readme

Browse source
This commit is contained in:
mose 2019-04-25 08:36:04 +08:00
parent 61016e87c8
commit 8a990a9df8
1 changed files with 6 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -13,7 +13,6 @@ documentation https://docs.gitlab.com/ce/user/project/pages/.
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* **Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [GitLab CI](#gitlab-ci)
- [Building locally](#building-locally) - [Building locally](#building-locally)
- [GitLab User or Group Pages](#gitlab-user-or-group-pages) - [GitLab User or Group Pages](#gitlab-user-or-group-pages)
- [Did you fork this project?](#did-you-fork-this-project) - [Did you fork this project?](#did-you-fork-this-project)
@ -21,10 +20,13 @@ documentation https://docs.gitlab.com/ce/user/project/pages/.
<!-- END doctoc generated TOC please keep comment here to allow auto update --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->
## GitLab CI ## Using docker-compose
This project's static Pages are built by [GitLab CI][ci], following the steps To build and serve locally without installing anything, provided that you have docker running:
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml).
docker-compose up
Then browse http://localhost:1313/
## Building locally ## Building locally
@ -45,25 +47,6 @@ your site can be accessed under `localhost:1313/hugo/`.
The theme used is adapted from http://themes.gohugo.io/beautifulhugo/. The theme used is adapted from http://themes.gohugo.io/beautifulhugo/.
## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to `namespace.gitlab.io`, where `namespace` is
your `username` or `groupname`. This can be done by navigating to your
project's **Settings**.
You'll need to configure your site too: change this line
in your `config.toml`, from `"https://pages.gitlab.io/hugo/"` to `baseurl = "https://namespace.gitlab.io"`.
Proceed equally if you are using a [custom domain][post]: `baseurl = "http(s)://example.com"`.
Read more about [user/group Pages][userpages] and [project Pages][projpages].
## Did you fork this project?
If you forked this project for your own use, please go to your project's
**Settings** and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
## Troubleshooting ## Troubleshooting
1. CSS is missing! That means two things: 1. CSS is missing! That means two things:
@ -72,7 +55,6 @@ unless you want to contribute back to the upstream project.
your static generator has a configuration option that needs to be explicitly your static generator has a configuration option that needs to be explicitly
set in order to serve static assets under a relative URL. set in order to serve static assets under a relative URL.
[ci]: https://about.gitlab.com/gitlab-ci/
[hugo]: https://gohugo.io [hugo]: https://gohugo.io
[install]: https://gohugo.io/overview/installing/ [install]: https://gohugo.io/overview/installing/
[documentation]: https://gohugo.io/overview/introduction/ [documentation]: https://gohugo.io/overview/introduction/