document-everything/_config.yml at master · jtebert/document-everything · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: Julia's Docs
email: julia@juliaebert.com
description: >- # this means to ignore newlines until "baseurl:"
  This documents the miscellaneous techy things I do for research,
  running Linux, side projects and taking over the world. It's mostly for me, but if you find
  something useful, that's cool too.
# baseurl: "/document-everything/" # the subpath of your site, e.g. /blog
url: "https://docs.juliaebert.com" # the base hostname & protocol for your site, e.g. http://example.com
twitter_username: jtebert
github_username:  jtebert

# Heading anchor links appear on hover over h1-h6 tags in page content
# allowing users to deep link to a particular heading on a page.
#
# Supports true (default) or false/nil
heading_anchors: true

# Footer content appears at the bottom of every page's main content
footer_content: "&copy; 2019&ndash;2022 by Julia Ebert"

# Google Analytics Tracking (optional)
# e.g, UA-1234567-89
ga_tracking: UA-54476418-2

# Date formatting (set defaults)
date_format: '%Y %B %e'

# Build settings
markdown: kramdown
# remote_theme: pmarsceill/just-the-docs
remote_theme: just-the-docs/just-the-docs@main
# remote_theme: cbteeple/just-the-docs

# plugins:
  # - jekyll-feed
  # - jekyll-last-modified-at

kramdown:
  toc_levels: "2"
  parse_block_html: true

# Configuration for just-the-docs

# Enable or disable the site search
search_enabled: true

# Aux links for the upper right navigation
aux_links:
    "Home":
      - "//juliaebert.com"
    "GitHub":
      - "//github.com/jtebert"
# Color scheme currently only supports "dark" or nil (default)
color_scheme: "jtebert"

# Exclude from processing.
# The following items will not be processed, by default. Create a custom list
# to override the default setting.
# exclude:
#   - Gemfile
#   - Gemfile.lock
#   - node_modules
#   - vendor/bundle/
#   - vendor/cache/
#   - vendor/gems/
#   - vendor/ruby/

# Define Jekyll collections
collections:
  # Define a collection named "docs", its documents reside in the "_docs" directory
  docs:
    permalink: "/:path/"
    output: true
    title: 'Everything Else'
  programming:
    permalink: "/:collection/:path/"
    output: true
    title: Programming
  projects:
    permalink: "/:collection/:path/"
    output: true
    title: Projects

just_the_docs:
  # Define which collections are used in just-the-docs
  collections:
    projects:
      name: Projects
    programming:
      name: Programming
    docs:
      name: Everything Else

defaults:
  -
    scope:
      # an empty string here means all files in the project - THAT BREAKS JTD
      # This gets things in all the collections
      # It's a hack around this bug: https://github.com/pmarsceill/just-the-docs/issues/472
      path: "_*"
    values:
      layout: "page"
      date: "1970-01-01"

# 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: '%Y %B %e' # 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/jtebert/document-everything" # the github URL for your repo
gh_edit_branch: "master" # the branch that your docs is served from
# gh_edit_source: docs # the source that your files originate from
gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately


# #CBTEEPLE

# nav_bullets: children # all, children

# image_lightbox: True