Skip to content

Commit

Permalink
differences for PR #216
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 22, 2024
1 parent 114a34e commit d6befa6
Show file tree
Hide file tree
Showing 4 changed files with 447 additions and 1 deletion.
92 changes: 92 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
#------------------------------------------------------------
# Values for this lesson.
#------------------------------------------------------------

# Which carpentry is this (swc, dc, lc, or cp)?
# swc: Software Carpentry
# dc: Data Carpentry
# lc: Library Carpentry
# cp: Carpentries (to use for instructor traning for instance)
carpentry: 'cp'

# Overall title for pages.
title: 'Introduction to The Carpentries Workbench'

# Date the lesson was created (this is empty by default)
created: ~

# Comma-separated list of keywords for the lesson
keywords: 'static site, lesson template, markdown, R, software'

# Life cycle stage of the lesson
# possible values: pre-alpha, alpha, beta, stable
life_cycle: 'beta'

# License of the lesson
license: 'CC-BY 4.0'

# Link to the source repository for this lesson
source: 'https://github.com/carpentries/sandpaper-docs/'

# Default branch of your lesson
branch: 'main'

# Who to contact if there are any issues
contact: '[email protected]'

# Navigation ------------------------------------------------
#
# Use the following menu items to specify the order of
# individual pages in each dropdown section. Leave blank to
# include all pages in the folder.
#
# Example -------------
#
# episodes:
# - introduction.md
# - first-steps.md
#
# learners:
# - setup.md
#
# instructors:
# - instructor-notes.md
#
# profiles:
# - one-learner.md
# - another-learner.md

# Order of episodes in your lesson
episodes:
- introduction.md
- episodes.Rmd
- editing.md
- example.Rmd
- deployment.md
- update.md
- pull-request.md

# Information for Learners
learners:
- reference.md
- setup.md
- github-pat.md
- component-guide.md
- migrating-from-styles.md
- style.md

# Information for Instructors
instructors:
- instructor-notes.md

# Learner Profiles
profiles:
- maintainer.md
- instructor.md

# Customisation ---------------------------------------------
#
# This space below is where custom yaml items (e.g. pinning
# sandpaper and varnish versions) should live


12 changes: 12 additions & 0 deletions editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,17 @@ profiles
: Learner profile pages
::::::::::::::::::::::::::::::: callout
### Remove Episode Numbering
By default, the lesson sidebar will display numbers next to each episode title. To remove these
numbers, add the following line to your `config.yaml` file.

`disable_sidebar_numbering: true`

::::::::::::::::::::::::::::::::::::::::::

::::::::::::::::::::::::::::::: challenge

### Configuring Episode Order
Expand All @@ -225,6 +236,7 @@ have rearranged themselves to reflect that.
::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::


### Configuring web analytics
The optional `analytics` field can be used to configure web analytics, e.g. with [Matomo](https://matomo.org/) or Google Analytics.
There are currently three options for `analytics`:
Expand Down
2 changes: 1 addition & 1 deletion md5sum.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"links.md" "a7ea11385a9d821b8f57edb0951c83ca" "site/built/links.md" "2024-11-19"
"episodes/introduction.md" "b1ca0d51bfee1538beabc08f46b389cf" "site/built/introduction.md" "2024-11-19"
"episodes/episodes.Rmd" "4f9401544dcfcd6d0ba5b61dca806f04" "site/built/episodes.md" "2024-11-19"
"episodes/editing.md" "128cafa31bca6233e1b8f565f4e884d8" "site/built/editing.md" "2024-11-19"
"episodes/editing.md" "2a19d428a2c17439b04b6f8a839d5cb8" "site/built/editing.md" "2024-11-22"
"episodes/example.Rmd" "215e3c4ed500fef3410f040349fb0a73" "site/built/example.md" "2024-11-19"
"episodes/deployment.md" "f15377cac190ef5435a60d074aa8aeb3" "site/built/deployment.md" "2024-11-19"
"episodes/update.md" "e3939117fb9b893806c4f43e7f08594e" "site/built/update.md" "2024-11-19"
Expand Down
Loading

0 comments on commit d6befa6

Please sign in to comment.