Skip to content

Commit

Permalink
transfer guides to its own module dir
Browse files Browse the repository at this point in the history
  • Loading branch information
Dedekind561 committed Jun 6, 2024
1 parent 294ed41 commit e9b47ad
Show file tree
Hide file tree
Showing 184 changed files with 2,559 additions and 1 deletion.
182 changes: 182 additions & 0 deletions org-cyf-guides/README.md

Large diffs are not rendered by default.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
10 changes: 10 additions & 0 deletions org-cyf-guides/assets/custom-images/site-logo/site-logo-small.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions org-cyf-guides/assets/custom-images/site-logo/site-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
75 changes: 75 additions & 0 deletions org-cyf-guides/assets/custom-theme/02-variables/colors.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
@mixin light-palette {
// these brand colours are set and then everything else is derived from the key
--theme-color--brand: hsla(0, 100%, 67%, 1);
--theme-color--brand-shade: hsla(0, 100%, 67%, 0.375);
--theme-color--accent: hsla(220, 100%, 62%, 1);
--theme-color--accent-shade: hsla(220, 100%, 62%, 0.15);
--theme-color--pop: rgb(255, 53, 140);
// key
--hue: 220;
--sat: 30%;
--lum: 90%;
--alpha: 0.95;
--hsl: var(--hue), var(--sat), var(--lum);
// now build all the shades
--theme-color--paper: hsla(
var(--hue),
calc(var(--sat) * 1.2),
calc(var(--lum) * 1.06),
var(--alpha)
);
--theme-color--ink: hsla(
var(--hue),
calc(var(--sat) * 2.2),
calc(var(--lum) * 0.3),
var(--alpha)
);
--theme-color--ink-fade: hsla(
var(--hue),
calc(var(--sat) * 2.2),
calc(var(--lum) * 0.3),
calc(var(--alpha) * 0.3)
);
--theme-color--paper-fade: hsla(
var(--hue),
calc(var(--sat) * 1.2),
calc(var(--lum) * 1.06),
0.9
);
--theme-color--contrast-max: hsl(
var(--hue),
calc(var(--sat) / 100),
calc(var(--lum) * 2) var(--alpha)
);

// backdrop
--theme-color--block: hsla(var(--hsl), var(--alpha));
--theme-color--outline: hsl(var(--hsl), 1);
--theme-color--backdrop-from: hsl(var(--hsl) / 0.25);
--theme-color--backdrop-to: hsl(var(--hsl) / 0.2);
}

@mixin dark-palette {
--hue: 270;
--sat: 8%;
--lum: 20%;
--alpha: 0.99;
--theme-color--ink: hsla(
calc(var(--hue) * 1.1),
calc(var(--sat) + 60%),
calc(var(--lum) * 4.4),
var(--alpha)
);
--theme-color--accent: hsla(262, 100%, 67%, 1);
--theme-color--pop: hsl(146, 100%, 46%);
}

:root {
@include light-palette();
@media (prefers-color-scheme: dark) {
@include dark-palette();
}
}

// see states for classes that toggle these
// no classes in the variables folder
7 changes: 7 additions & 0 deletions org-cyf-guides/assets/custom-theme/02-variables/fonts.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:root {
--theme-font--display: "Fira Mono", "Monaco", monospace;
--theme-font--copy: "Fira Sans", system-ui, -apple-system, BlinkMacSystemFont,
"Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Open Sans", "Helvetica Neue",
sans-serif;
--theme-font--system: 100 100%/2 "Fira Mono", "Monaco", "Menlo", monospace;
}
4 changes: 4 additions & 0 deletions org-cyf-guides/assets/custom-theme/states/dark.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.is-dark-mode,
:root:has(.is-dark-mode) {
@include dark-palette;
}
4 changes: 4 additions & 0 deletions org-cyf-guides/assets/custom-theme/states/light.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
.is-light-mode,
:root:has(.is-light-mode) {
@include light-palette;
}
12 changes: 12 additions & 0 deletions org-cyf-guides/config/issues-are-cached-and-incomplete/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# This config is optimised for speed of local interation of general Hugo set-up without worrying about issue freshness or completeness.
# To build with this config, run `hugo server --environment issues-are-cached-and-incomplete`.

[params]
# Don't use the paginating proxy, because it's slow.
# This means some issues will be missing when fetched.
issuesorgapi = "https://api.github.com/repos/CodeYourFuture/"

[caches.getjson]
# Cache JSON responses because making fetches is slow when iterating.
# This means updates to issues (or newly created ones) won't be picked up when rebuilding.
maxAge = "4h"
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
id: contributing
title: Contributing
weight: 2
emoji: 🎁
emoji:
---


<!-- CYF-ONLY -->
## 💯 Free and open

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ title="Deploying"
description="Deploying your applications to the web using free services like Netlify and Vercel."
emoji="🚀"
+++

File renamed without changes.
File renamed without changes.
File renamed without changes.
12 changes: 12 additions & 0 deletions org-cyf-guides/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
module github.com/CodeYourFuture/curriculum/org-cyf-piscine

go 1.21.3

require (
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240121151641-e52b73ad527d // indirect
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240121151641-e52b73ad527d // indirect
)

replace github.com/CodeYourFuture/curriculum/common-content => ../common-content
replace github.com/CodeYourFuture/curriculum/common-theme => ../common-theme

8 changes: 8 additions & 0 deletions org-cyf-guides/go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240114132825-493a89648721 h1:txnduLXqSKf3XHb/g74uhpGltb9FgyrdrMeC/Ce3vr0=
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240114132825-493a89648721/go.mod h1:w5rIm9hJlHD+CYpQEVMWE/6WaE/EiLmYVs18Kw/iH0s=
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240121151641-e52b73ad527d h1:WfPdLoNvxOrNx3GB+DpYlpEH57v98h0KWXpidN+xdOo=
github.com/CodeYourFuture/curriculum/common-content v0.0.0-20240121151641-e52b73ad527d/go.mod h1:e3J+XphCBJJ8kf6S9ykVxNY1VKPWJoYuDFXEizlDpCI=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240114132825-493a89648721 h1:GSd+9AsvXJEjy2AvsP79YBpmMRhxydDhVvlbD5x5DKg=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240114132825-493a89648721/go.mod h1:lWiQfXWr0Uc517tksx7D5p5ZoXo9bxRoJ0or+z9mRyk=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240121151641-e52b73ad527d h1:ILE8f9gXLEPEyrJVBdFRVa0Uszf9OVdK4LjXZjCLUag=
github.com/CodeYourFuture/curriculum/common-theme v0.0.0-20240121151641-e52b73ad527d/go.mod h1:kzt+J4JYp5C3GD1dX0rf7vY5fsTUc6Drrn+7p7pjmLg=
73 changes: 73 additions & 0 deletions org-cyf-guides/hugo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
title = "CYF Piscine"
baseURL = "https://curriculum.codeyourfuture.io/"

[taxonomies]
category = 'categories' # Content types are blocks, definitions, guides
tag = 'themes'
activity = 'activities'


[module]
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum/common-theme"
[[module.imports]]
path = "github.com/CodeYourFuture/curriculum/common-content"
[[module.imports.mounts]]
source = "en"
target = "content"

[menus]
[[menus.secondary]]
name = "Guides 👈🏾"
weight = 1
url = "https://curriculum.codeyourfuture.io/guides"
[[menus.secondary]]
name = "Join Us 👋🏿"
weight = 2
url = "https://codeyourfuture.io/volunteers/"
[[menus.secondary]]
name = "Support 🫶🏼"
weight = 3
url = "https://codeyourfuture.io/donate/"

[params]
googleFonts="https://fonts.googleapis.com/css2?family=Fira+Sans&Fira+Mono&display=swap"
description = "A free and open source software development programme."
main_website = "https://codeyourfuture.io/"
main_org_name = "Code Your Future"
org = "https://github.com/CodeYourFuture"
repo = "https://github.com/CodeYourFuture/curriculum/"
pdrepo = "CYF-PD"
root = "curriculum"
orgapi = "https://api.github.com/repos/CodeYourFuture/"
# We use a proxy which concatenates paginated responses, otherwise we miss results.
# Daniel is currently hosting this code https://github.com/illicitonion/github-issue-proxy but we should work out a long-term maintainable solution to this problem.
issuesorgapi = "https://github-issue-proxy.illicitonion.com/repos/CodeYourFuture/"


[caches.getjson]
# Disable caching of fetches - we want every build to get up to date content for issues, so that if people make clarifications or fixes to issues, we pick them up.
maxAge = 0

[security.funcs]
# Allow accessing a GitHub bearer token to avoid rate limits when doing HTTP fetches to the GitHub API.
# This can be generated at https://github.com/settings/tokens?type=beta and needs read-only access to all public CYF GitHub repos.
getenv = ["^HUGO_CURRICULUM_GITHUB_BEARER_TOKEN$"]

[markup]
[markup.tableOfContents]
endLevel = 2
ordered = true
startLevel = 2
[markup.highlight]
lineNos = false
codeFences = true
guessSyntax = true
[markup.goldmark.renderer]
# Enable HTML codeblocks, e.g. for <details> blocks
unsafe = true
hardWraps = true
footnote= true


theme = "common-theme"
Loading

0 comments on commit e9b47ad

Please sign in to comment.