Installation | Chulapa

Chulapa was developed in and for Github. There are three tested possible ways to use Chulapa:

1. Use our Github Template

Recommended if you are starting from scratch

Create a Github account, click this link and quickstart your site!

2. Remote theme method

Recommended if you are migrating a site.

You can use the jekyll-remote-theme method. Just follow these steps:

Create a new GitHub repository or go to an existing one.

Add this line to your _config.yml:

 remote_theme: dieghernan/chulapa
 ... more config options

Remove other remote_theme/theme instances from your _config.yml file.

Don’t forget to deploy your site:

On your Github repo, go to Settings > Github Pages.
Select Source > Github Actions and set the corresponding action. See an example in https://github.com/dieghernan/chulapa-101/blob/main/.github/workflows/build-chulapa-gh-pages.yml

By using jekyll-remote-theme, your repo will have remote access to the content of these folders:

assets
_layouts
_includes
_sass

Note that making copies of theme files will prevent you from receiving any theme updates on those files.

Please read the rest of the docs for further adjustments.

3. Gem-based method

With Gem-based themes, directories such as the assets, _layouts, _includes, and _sass are stored in the theme’s gem, hidden from your immediate view. This allows for easier installation and updating as you don’t have to manage any of the theme files.

To install as a Gem-based theme:

Add the following to your Gemfile:
```
 gem "chulapa-jekyll"
```
Fetch and update bundled gems by running the following Bundler command:
```
 bundle
```
Set the theme in your project’s Jekyll _config.yml file:
```
 theme: chulapa-jekyll
```

To update the theme, run bundle update.