Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add theme details #164

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 103 additions & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,104 @@
title: Open Source Commons Data Generation Toolkit Website
title: Snowfakery Recipe Templates
description: Information about Salesforce.org Open Source Commons and Community Sprints
timezone: America/New_York
baseurl: "/" # the subpath of your site, e.g. /blog
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be /Snowfakery-Recipe-Templates although I'm not 100% certain. The main Sprint material lives at https://sfdo-community-sprints.github.io/, this project's pages are at https://sfdo-community-sprints.github.io/Snowfakery-Recipe-Templates/. If you're certain this is right, I'll believe you, but my uncertain gut check is that this file's baseurl should be /Snowfakery-Recipe-Templates

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently we just have repo feeding a standalone site - would need to talk to @coriobriensfdo about what she'd prefer.

url: "https://sfdo-community-sprints.github.io/" # the base hostname & protocol for your site, e.g. http://example.com
aux_links:
"Snowfakery Recipe Templates on Github":
- "//github.com/SFDO-Community-Sprints/Snowfakery-Recipe-Templates"

theme: jekyll-theme-leap-day
# Information on theme https://just-the-docs.GitHub.io/just-the-docs/
remote_theme: just-the-docs/just-the-docs

# Color scheme supports "light" (default) and "dark"
color_scheme: dark

# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/OSC-header.png"

permalink: pretty
exclude:
[
"node_modules/",
"*.gemspec",
"*.gem",
"Gemfile",
"Gemfile.lock",
"package.json",
"package-lock.json",
"script/",
"LICENSE.txt",
"lib/",
"bin/",
"README.md",
"Rakefile",
"docs/tests/",
]

# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
search:
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of previews per search result
# Default: 3
previews: 2
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 3
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 3
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/
# Display the relative url in search results
# Supports true (default) or false
rel_url: true
# Enable or disable the search button that appears in the bottom right corner of every page
# Supports true or false (default)
button: false

# Footer content
# appears at the bottom of every page's main content

# Back to top link
back_to_top: true
back_to_top_text: "Back to top"

# Footer last edited timestamp
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html

# Footer "Edit this page on GitHub" link text
# gh_edit_link: true # show or hide edit this page link
# gh_edit_link_text: "Edit this page on GitHub"
# gh_edit_repository: "https://GitHub.com/just-the-docs/just-the-docs" # the GitHub URL for your repo
# gh_edit_branch: "main" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
# gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately

plugins:
- jekyll-seo-tag

kramdown:
syntax_highlighter_opts:
block:
line_numbers: false

compress_html:
clippings: all
comments: all
endings: all
startings: []
blanklines: false
profile: false
# ignore:
# envs: all
# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
# ga_tracking: UA-2709176-10
# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)