Getting Started instructions added to README.md
This commit is contained in:
26
README.md
26
README.md
@ -14,6 +14,9 @@ documentation https://docs.gitlab.com/ce/user/project/pages/.
|
||||
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
||||
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Start by forking this repository](#start-by-forking-this-repository)
|
||||
- [Start from a local Jekyll project](#start-from-a-local-jekyll-project)
|
||||
- [GitLab CI](#gitlab-ci)
|
||||
- [Building locally](#building-locally)
|
||||
- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
|
||||
@ -22,6 +25,29 @@ documentation https://docs.gitlab.com/ce/user/project/pages/.
|
||||
|
||||
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
||||
|
||||
## Getting Started
|
||||
|
||||
You can get started with GitLab Pages using Jekyll easily by either forking this repository or by uploading a new/existing Jekyll project.
|
||||
|
||||
Remember you need to wait for your site to build before you will be able to see your changes. You can track the build on the **Pipelines** tab.
|
||||
|
||||
### Start by forking this repository
|
||||
|
||||
1. Fork this repository.
|
||||
1. **IMPORTANT:** Remove the fork relationship.
|
||||
Go to **Settings (⚙)** > **Edit Project** and click the **"Remove fork relationship"** button.
|
||||
1. Enable Shared Runners.
|
||||
Go to **Settings (⚙)** > **CI/CD Pipelines** and click the **"Enable shared Runners"** button.
|
||||
1. Rename the repository to match the name you want for your site.
|
||||
1. Edit your website through GitLab or clone the repository and push your changes.
|
||||
|
||||
### Start from a local Jekyll project
|
||||
|
||||
1. [Install][] Jekyll.
|
||||
1. Use `jekyll new` to create a new Jekyll Project.
|
||||
1. Add [this `.gitlab-ci.yml`](.gitlab-ci.yml) to the root of your project.
|
||||
1. Push your repository and changes to GitLab.
|
||||
|
||||
## GitLab CI
|
||||
|
||||
This project's static Pages are built by [GitLab CI][ci], following the steps
|
||||
|
Reference in New Issue
Block a user