CMDBrew/entree

Jamstack with Jekyll, Forestry(forestry.io) and Github

CMDBrew Jekyll Theme

Getting started

1. Add this line to your Jekyll site's Gemfile gem "entree"
2. Add this line to your Jekyll site's _config.yml theme: entree
3. Copy the plugins in _config.yml to your Jekyll site's _config.yml.
4. Run bundle install
5. Copy sample data files from _data directory to your project
6. Copy sample configs from _config.yml to your project
7. Copy 404.html to your project.
8. Run jekyll server to start up server.

Setup Netlify

For references see https://docs.netlify.com/large-media/setup/

1. Connect your site to your github repo.
2. netlify link
3. netlify lm:setup
4. git lfs track "uploads/**"
5. Commit your settings git add -A and git commit -m 'Setup Netlify Large Media'.

Customize Styles

1. enable custom style sheets by adding the following in your _config.yml

   entree:
     sass:
       custom_vars: 'custom_vars'
       custom_styles:
         - 'custom_style'

2. custom_vars is used for variable overrides.
3. custom_styles are used for additional styles that overrides defined styles.

Customize Aside

1. Copy installs.yml to your project.
2. Customize the call to action:
   1. The call to action is under key call_to_action.
3. Customize actions:
   1. The action items are under key actions.
4. Customize social links:
   1. The action items are under key socials.
   2. We are using FontAwesome 5. You can use free icons from https://fontawesome.com/icons?d=gallery&m=free.
   3. You can search social network brand colors from https://brandcolors.net/.
5. Customize the footnote:
   1. The footnote is under key footnote.

Enable Installs

1. Enable PWA:
   1. Copy pwa.yml to your project.
   2. Make sure you have pwa enabled set to true inside your pwa.yml.
   3. Copy serviceworker.js and manifest.json to your project.
2. Enable Smart Banner:
   1. Copy smartbanner.yml to your project.
   2. Make sure you have smartbanner enabled set to true inside your installs.yml.

Update translations

1. Copy translations.yml to your project.

Add Social Sharing

1. Copy files in [social_feeds] to your project. For examples to enable it in your post see 2016-05-20-my-example-post.md.

Cookies Policy

1. Enable Cookies Policy by setting cookies_policy: true inside entree in _config.yml

   entree:
     cookies_policy: true

Development

1. Run gulp to copy npm packages to assets/vendors.
2. Run npm start to compile js to main-bundle.js.
3. Run jekyll server to start the server.

Frameworks

Framework	Description
Bootstrap	Frontend framework

Reports

Framework	Description
LicenseFinder	List out gem licenses bundle exec license_finder report --format html > licenses.html.
Inch	See documentation analytics by running inch.

License

Please see LICENSE for licensing details.