octopress

octopress

Example Octopress site using GitLab Pages: https://pages.gitlab.io/octopress

Name Last Update
.themes/classic Loading commit data...
plugins Loading commit data...
sass Loading commit data...
source Loading commit data...
.editorconfig Loading commit data...
.gitattributes Loading commit data...
.gitignore Loading commit data...
.gitlab-ci.yml Loading commit data...
.powrc Loading commit data...
.slugignore Loading commit data...
.travis.yml Loading commit data...
CHANGELOG.markdown Loading commit data...
Gemfile Loading commit data...
README.md Loading commit data...
Rakefile Loading commit data...
_config.yml Loading commit data...
config.rb Loading commit data...
config.ru Loading commit data...
octopress.markdown Loading commit data...

Build Status


Example Octopress website using GitLab Pages.

Learn more about GitLab Pages at https://pages.gitlab.io and the official documentation https://docs.gitlab.com/ce/user/project/pages/.


Table of Contents generated with DocToc

GitLab CI

This project's static Pages are built by GitLab CI, following the steps defined in .gitlab-ci.yml:

image: ruby:2.3

pages:
  script:
  - bundle install -j4
  - bundle exec rake generate
  - mv public .public
  - mv .public/octopress public
  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
  2. Install Octopress and its dependencies: bundle install
  3. Generate the website: rake generate
  4. Preview your project: rake preview
  5. Visit http://localhost:4000/octopress
  6. Add content

Read more at the Octopress 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 and project Pages.

Finally, Octopress needs to be configured to be deployed in the root directory. In short:

  1. Run locally: rake set_root_dir[/]
  2. Edit _config.yml and change the url
  3. Edit gitlab-ci.yml to look like:

    image: ruby:2.3
    
    pages:
      script:
      - bundle install -j4
      - bundle exec rake generate
      artifacts:
        paths:
        - public
      only:
      - master
  4. Commit and push your changes

When you hack locally, remember that the preview location will be at http://localhost:4000.

Follow http://octopress.org/docs/deploying/subdir/ for more details.

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.