diff --git a/README.md b/README.md index 2086fea..fffc89a 100644 --- a/README.md +++ b/README.md @@ -2,88 +2,7 @@ --- -Example [Hexo] website using GitLab Pages. -Learn more about GitLab Pages at https://pages.gitlab.io and the official -documentation http://doc.gitlab.com/ee/pages/README.html. - ---- - - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [GitLab CI](#gitlab-ci) -- [Building locally](#building-locally) -- [GitLab User or Group Pages](#gitlab-user-or-group-pages) -- [Did you fork this project?](#did-you-fork-this-project) -- [Troubleshooting](#troubleshooting) - - - -## GitLab CI - -This project's static Pages are built by [GitLab CI][ci], following the steps -defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): - -``` -image: node:4.2.2 - -pages: - cache: - paths: - - node_modules/ - - script: - - npm install hexo-cli -g - - npm install - - hexo deploy - artifacts: - paths: - - public - only: - - master -``` - -## Building locally - -To work locally with this project, you'll have to follow the steps below: - -1. Fork, clone or download this project -1. [Install][] Hexo and [Hexo Server][hexo-server] -1. Install dependencies: `npm install` -1. Preview your site: `hexo server` -1. Add content -1. Generate your site (optional): `hexo generate` - -Read more at Hexo's [documentation][]. - -## 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**. - -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 - -1. CSS is missing! That means two things: - - Either that you have wrongly set up the CSS URL in your templates, or - your static generator has a configuration option that needs to be explicitly - set in order to serve static assets under a relative URL. - ----- - -Forked from @VeraKolotyuk [ci]: https://about.gitlab.com/gitlab-ci/ [hexo]: https://hexo.io