Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dieghernan committed Nov 24, 2022
1 parent ffa60ec commit 5d4589a
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 22 deletions.
Binary file removed chulapa-jekyll-0.1.0.gem
Binary file not shown.
63 changes: 42 additions & 21 deletions docs/collections/_docs/01_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,72 @@ subtitle: How to use <span class="chulapa">Chulapa</span>
excerpt: Install Chulapa on your Github repo
---

<span class="chulapa">Chulapa</span> was developed in and for Github. There are two tested possible ways to use <span class="chulapa">Chulapa</span>:
[Chulapa]{.chulapa} was developed in and for Github.
There are two tested possible ways to use [Chulapa]{.chulapa}:

## 1. Use our Github Template <i class="fa-solid fa-thumbs-up fa-xs"></i>

This is the **recommended option**.
Create a Github account, go to [chulapa-101 repo](https://github.com/dieghernan/chulapa-101), fork it and quickstart your site!

## 1. Remote theme method <i class="fas fa-thumbs-up fa-xs"></i>
## 2. Remote theme method

This is the **recommended option**. You can use the `jekyll-remote-theme` method with this theme. Create a Github account, go to [chulapa-101 repo](https://github.com/dieghernan/chulapa-101), fork it and quickstart your site!
If you prefer not to use the template, you can use the `jekyll-remote-theme` method.
Just follow these steps:

If you prefer not to fork the dedicated repo, follow these steps:
- Create a new GitHub repository or go to an existing one
- Add this line to your `_config.yml` and make sure to remove any previous theme or remote theme parameter:

- Create a new GitHub repository or go to an existing one
- Add this line to your `_config.yml` and make sure to remove any previous theme or remote theme parameter:

```yaml
``` yaml

remote_theme: dieghernan/chulapa

... more config options

```

- Remove other `remote_theme/theme` instances of your `_config.yml` file.

<div markdown="1" class="alert alert-warning p-3 mx-2">
::: {.alert .alert-warning .p-3 .mx-2 markdown="1"}
**Don't forget to deploy your site:**

- On your Github repo, go to *Setting > Github Pages* and publish your site.
- Add your content.
</div>
- On your Github repo, go to *Setting \> Github Pages* and publish your site.
- Add your content.
:::

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

- `assets`
- `_layouts`
- `_includes`
- `_sass`
- `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.

## Gem-based method <i class="fa-regular fa-gem fa-xs"></i>

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:

1. Add the following to your `Gemfile`:

``` ruby
gem "chulapa-jekyll"
```

2. Fetch and update bundled gems by running the following [Bundler](https://bundler.io/) command:

<h2 class="text-muted" id="gem-based">Gem-based method</h2>
``` bash
bundle
```

This theme has not been developed as a gem-based theme, so this option has been not explored yet.
3. Set the `theme` in your project's Jekyll `_config.yml` file:
``` yaml
theme: chulapa-jekyll
```
**Potentially:** After the first stable release.
{: .alert .alert-info .p-3 .mx-2}
To update the theme run `bundle update`.
32 changes: 31 additions & 1 deletion test/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,34 @@
.Rhistory
.RData
.Ruserdata
project.Rproj
/*.Rproj

# Vim
*~
*.sw[p_]

# Sublime Text
*.sublime-project
*.sublime-workspace

# Ruby Gem
*.gem
.bundle
Gemfile.lock
**/vendor/bundle

# Node.js and NPM
node_modules
npm-debug.log*
package-lock.json
codekit-config.json

# macOS
.DS_Store

# Jekyll generated files
.jekyll-cache
.jekyll-metadata
.sass-cache
_asset_bundler_cache
_site

0 comments on commit 5d4589a

Please sign in to comment.