From 4c2e229af89dacbbaf96cd527b8959c9af45e0d9 Mon Sep 17 00:00:00 2001 From: Dooho Yi Date: Sun, 12 Apr 2020 15:26:09 +0900 Subject: [PATCH] =?UTF-8?q?/=20=E2=80=98README.md=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 75 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index b135cc9..cd3d02c 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,4 @@ -![Build Status](https://gitlab.com/pages/pelican/badges/master/build.svg) +# Example [Pelican] website using GitLab server ----- - -Example [Pelican] website using GitLab Pages. Check the resulting website here: - -Learn more about GitLab Pages at https://pages.gitlab.io and the [official -documentation](https://docs.gitlab.com/ce/user/project/pages/), including -[how to fork a project like this one to get started from](https://docs.gitlab.com/ee/user/project/pages/getting_started_part_two.html#fork-a-project-to-get-started-from). - ---- - - - -**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 the file [`.gitlab-ci.yml`](.gitlab-ci.yml). - -## 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][] Pelican -1. Regenerate and serve on port 8000: `make devserver` -1. Add content - -Read more at Pelican's [documentation]. - -## GitLab User or Group Pages - -To use this project as your user/group website, you will need to perform -some additional steps: - -1. 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 > General (Advanced)**. - -2. Adjust Pelican's `SITEURL` configuration setting in `publishconf.py` to -the new URL (e.g. `https://namespace.gitlab.io`) - -Read more about [GitLab Pages for projects and user/group websites][pagesdoc]. - -## 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. - -[ci]: https://about.gitlab.com/gitlab-ci/ -[pelican]: http://blog.getpelican.com/ -[install]: https://docs.getpelican.com/en/stable/install.html -[documentation]: http://docs.getpelican.com/ -[pagesdoc]: https://docs.gitlab.com/ce/user/project/pages/getting_started_part_one.html +- located https://nosignal.hopto.org/gitlab +- Check the resulting website here: