diff --git a/chulapa-jekyll-0.1.0.gem b/chulapa-jekyll-0.1.0.gem deleted file mode 100644 index 8807c4d93..000000000 Binary files a/chulapa-jekyll-0.1.0.gem and /dev/null differ diff --git a/docs/collections/_docs/01_install.md b/docs/collections/_docs/01_install.md index e6ccc89e2..f203f00d3 100644 --- a/docs/collections/_docs/01_install.md +++ b/docs/collections/_docs/01_install.md @@ -4,51 +4,72 @@ subtitle: How to use Chulapa excerpt: Install Chulapa on your Github repo --- -Chulapa was developed in and for Github. There are two tested possible ways to use Chulapa: +[Chulapa]{.chulapa} was developed in and for Github. +There are two tested possible ways to use [Chulapa]{.chulapa}: +## 1. Use our Github Template +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 +## 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. -
+::: {.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. -
+- 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 + +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: -

Gem-based method

+ ``` 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`. diff --git a/test/.gitignore b/test/.gitignore index 4eca7113d..f1b65049e 100644 --- a/test/.gitignore +++ b/test/.gitignore @@ -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