feat(3.1.0): add landing page title (#475)

freeCodeCamp · Feb 5, 2024 · 290a263 · 290a263
2 parents 1633eb1 + 958785d
commit 290a263
Show file tree

Hide file tree

Showing 12 changed files with 937 additions and 726 deletions.
diff --git a/.freeCodeCamp/client/templates/landing.css b/.freeCodeCamp/client/templates/landing.css
@@ -1,3 +1,9 @@
+.description {
+  max-width: 750px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
 .blocks {
   list-style-type: none;
   display: flex;
@@ -33,7 +39,7 @@
   cursor: pointer;
   background-color: var(--dark-3);
 }
-.tags-row{
+.tags-row {
   display: flex;
 }
 
@@ -49,4 +55,4 @@
   width: -webkit-fit-content;
   width: -moz-fit-content;
   width: fit-content;
-}
+}
diff --git a/.freeCodeCamp/client/templates/landing.tsx b/.freeCodeCamp/client/templates/landing.tsx
@@ -15,8 +15,10 @@ export const Landing = ({
   freeCodeCampConfig,
   locale
 }: LandingProps) => {
+  const title = freeCodeCampConfig.client?.landing?.[locale]?.title;
   return (
     <>
+      {title && <h1>{title}</h1>}
       <p className='description'>
         {freeCodeCampConfig.client?.landing?.[locale]?.description}
       </p>

diff --git a/cli/Cargo.toml b/cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "create-freecodecamp-os-app"
-version = "3.0.0"
+version = "3.0.1"
 edition = "2021"
 description = "CLI to create the boilerplate for a new freeCodeCamp-OS app"
 license = "BSD-3-Clause"

diff --git a/cli/src/conf.rs b/cli/src/conf.rs
@@ -38,6 +38,7 @@ pub struct Assets {
 
 #[derive(Serialize, Deserialize, Debug)]
 pub struct Landing {
+    pub title: String,
     pub description: String,
     #[serde(rename = "faq-link")]
     pub faq_link: Option<String>,

diff --git a/cli/src/fs.rs b/cli/src/fs.rs
@@ -104,7 +104,7 @@ impl Course {
           "author": "",
           "license": "MIT",
           "dependencies": {
-            "@freecodecamp/freecodecamp-os": "^3.0.0"
+            "@freecodecamp/freecodecamp-os": "^3.1.0"
           },
           "type": "module"
         });
@@ -173,6 +173,7 @@ impl Course {
                 assets: None,
                 landing: Some(json!({
                     "english": Landing {
+                        title: "Course title".to_string(),
                         description: "Course description".to_string(),
                         faq_link: None,
                         faq_text: None,

diff --git a/docs/src/CHANGELOG.md b/docs/src/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## [3.1.0] - 2024-02-05
+
+### Add
+
+- `client.landing.locale.title` field for landing page `h1`
+
+### Fix
+
+- Give `.description` element a `max-width` of `750px`
+- Add `ws` as dependency
+
 ## [3.0.0] - 2024-02-01
 
 ### Change

diff --git a/docs/src/configuration.md b/docs/src/configuration.md
@@ -54,7 +54,8 @@ By default, the server and client communicate over port `8080`. To change this,
 
 - `assets.header`: path relative to the root of the course - `string`
 - `assets.favicon`: path relative to the root of the course - `string`
-- `landing.description`: description of the course shown on the landing page - `string`
+- `landing.<locale>.description`: description of the course shown on the landing page - `string`
+- `landing.<locale>.title`: title of the course shown on the landing page - `string`
 - `landing.<locale>.faq-link`: link to the FAQ page - `string`
 - `landing.<locale>.faq-text`: text to display for the FAQ link - `string`
 - `static`: static resources to serve - `string | string[] | Record<string, string> | Record<string, string>[]`