Merge pull request #4 from dyvenia/readme

Readme

admin/config.yml

@@ -0,0 +1,116 @@
+# Sveltia CMS configuration
+
+# This is where we configure the CMS repo and its collections and fields
+# Sveltia CMS generally follows the Decap CMS configuration spec
+# Decap CMS docs: https://decapcms.org/docs/intro/
+# Sveltia CMS docs: https://github.com/sveltia/sveltia-cms#features
+
+local_backend: true
+
+# Enter your GitHub repo path and branch (defaults to master)
+backend:
+  name: github
+  repo: dyvenia/site-thescalableway
+  branch: main
+
+# The folder used to store uploaded images
+media_folder: "assets/images"
+
+# The CMS collections and their fields
+collections:
+
+  - name: "home"
+    label: "Home Page"
+    icon: "home"
+    create: false
+    extension: "njk"
+    format: "frontmatter"
+    files:
+      - file: "src/pages/index.njk"
+        label: "Home"
+        name: "home"
+        fields:
+          - { label: "Hero Title", name: "hero.title", widget: "string" }
+          - { label: "Hero Subtitle", name: "hero.subtitle", widget: "markdown" }
+          - { label: "Learn More Button Text", name: "hero.button_text", widget: "string" }
+          - { label: "Learn More Button Target", name: "hero.button_target", widget: "string" }
+          - { label: "Introduction Title", name: "intro.title", widget: "string" }
+          - { label: "Introduction Content", name: "intro.content", widget: "markdown" }
+          - { label: "Highlight One Title", name: "highlight_one.title", widget: "string" }
+          - { label: "Highlight One Subtitle", name: "highlight_one.subtitle", widget: "markdown" }
+          - { label: "Highlight Two Title One", name: "highlight_two.title1", widget: "string" }
+          - { label: "Highlight Two Title Two", name: "highlight_two.title2", widget: "string" }
+          - { label: "Highlight Two Content", name: "highlight_two.content", widget: "markdown" }
+          - { label: "5 Foundations Title One", name: "foundations_titles.title1", widget: "string" }
+          - { label: "5 Foundations Title Two", name: "foundations_titles.title2", widget: "string" }
+          - label: "Foundations Keys"
+            name: "foundations_elements" #<- this doesn't seem to work
+            widget: "list"
+            fields:
+              - { label: "Title", name: "title", widget: "string" }
+              - { label: "Content", name: "content", widget: "string" }
+          - { label: "About Us", name: "about.title", widget: "string" }
+          - { label: "About Us", name: "about.content", widget: "markdown" }
+          - { label: "Why Us", name: "whyus_intro.title", widget: "string" }
+          - { label: "Why Us Intro", name: "whyus_intro.content", widget: "string" }
+          - label: "Why Us - Elements"
+            name: "whyus_elements"
+            widget: "list"
+            fields:
+              - { label: "Title", name: "title", widget: "string" }
+              - { label: "Content", name: "content", widget: "string" }
+          - { label: "Our Services", name: "our_services.title", widget: "string" }
+          - label: "Our Services Items"
+            name: "our_services_items"
+            widget: "list"
+            fields:
+              - { label: "Title", name: "title", widget: "string" }
+              - { label: "Prefix", name: "prefix", widget: "string" }
+              - { label: "Description", name: "description", widget: "markdown" }
+
+  - name: "blog"
+    label: "Posts"
+    label_singular: "Post"
+    folder: "src/posts/2024"
+    create: true
+    slug: "{{slug}}"
+    fields:
+      - { label: "Title", name: "title", widget: "string" }
+      - { label: "Publish Date", name: "date", widget: "datetime" }
+      - { label: "Author", name: "author", widget: "string"}
+      - { label: "Description", name: "description", widget: "text" }
+      - { label: "Tags", name: "tags", widget: "list", default: ["post"], hint: "Enter tags separated by a comma" }
+      - { label: "Body", name: "body", widget: "markdown" }
+
+  - name: "imprint"
+    label: "Imprint"
+    icon: "policy"
+    extension: "yaml"
+    format: "yaml"
+    files:
+      - file: "src/_data/personal.yaml"
+        label: "Site Imprint"
+        name: "site"
+        fields:
+          - { label: "Email", name: "email", widget: "string", hint: "Public company email address i.e. hello@company.com" }
+          - { label: "Address", name: "address", widget: "text", hint: "Your company legal address" }
+
+  - name: "team"
+    label: "Team"
+    icon: "group"
+    create: true
+    extension: "yaml"
+    format: "yaml"
+    files:
+      - file: "src/_data/team.yaml"
+        label: "Team"
+        name: "team"
+        fields:
+            - label: "Admins"
+              name: "admin"
+              widget: "list"
+              fields:
+                - { label: "Name", name: "name", widget: "string" }
+                - { label: "Profile Picture", name: "image", widget: "image" }
+                - { label: "Short Description", name: "description_short", widget: "text" }
+                - { label: "Long Description", name: "description_long", widget: "text" }

eleventy.config.js

@@ -84,6 +84,12 @@ export default async function (eleventyConfig) {
 
   // --------------------- Passthrough File Copy
 
+  eleventyConfig.addPassthroughCopy("admin/"); // don't process the CMS folder
+  // Disable 11ty dev server live reload when using CMS locally
+  eleventyConfig.setServerOptions({
+    liveReload: false
+  });
+
   // -- same path
   ['src/assets/fonts/', 'src/assets/images/template', 'src/assets/og-images'].forEach(path =>
     eleventyConfig.addPassthroughCopy(path)

readme.md

@@ -1,7 +1,27 @@
 # The Scalable Way
 
-Based on [eleventy-excellent](https://github.com/madrilene/eleventy-excellent).
+The website of thescalable way dyvenia division.
 
+### Blog Contribution Guidelines
 
-### To Dos
-- optimize the syntax css load in css-inline.njk (now using a CDN)
+Blog articles are markdown files inside the `src/posts` folder. The top of the markdown has a YAML section to define article metadata such as title, description and publish date.
+
+**Code Blocks** are possible with the typical "```" opening and closing. Documentation on syntax highlighting and code blocks is [here](https://www.11ty.dev/docs/plugins/syntaxhighlight/).
+
+**images** should be stored in `src/images`.
+
+### Running the Site Locally
+
+This site is using a static page generator called `eleventy`, you can read its documentation [here](https://www.11ty.dev/).
+
+If you have `npm` installed, you should be able to run a local version running the commands below. Typically the local site will run on `http://127.0.0.1:8080/`.
+
+```bash
+cd site-thescalableway
+
+npm run start
+```
+
+### Theme Support
+
+For support see: [eleventy-excellent](https://github.com/madrilene/eleventy-excellent).

src/_data/personal.yaml

@@ -1,11 +1,7 @@
-email: hola@eyourmail.lol
+email: hello@dyvenia.com
 address: |-
-  Organization name
-  Your street
-  12345, city
-  Tel: +34 928231911
+  DYVENIA SPÓŁKA Z OGRANICZONĄ ODPOWIEDZIALNOŚCIĄ
+  Kraków 31-047, ul. Józefa Sarego 26/14
+  VAT 6762600902
 platforms:
-  github: ''
-  mastodon: ''
-  bluesky: ''
-  kofi: ''
+  github: ""

src/_data/team.yaml

@@ -1,26 +1,27 @@
-- name: Alessio Civitillo
-  image: alessio.jpg
-  description_short: |
-    An experienced financial analyst and software engineer, Alessio brings a unique blend of expertise and vision to the world of data, ensuring that our clients unlock the hidden connections in their data and deliver value to their stakeholders.
-  description_long: |
-    Alessio Civitillo has spent over a decade blending financial analysis with software engineering. His work focuses on helping clients discover valuable insights hidden in complex datasets.
+admin:
+  - name: Alessio Civitillo
+    image: alessio.jpg
+    description_short: |
+      An experienced financial analyst and software engineer, Alessio brings a unique blend of expertise and vision to the world of data, ensuring that our clients unlock the hidden connections in their data and deliver value to their stakeholders.
+    description_long: |
+      Alessio Civitillo has spent over a decade blending financial analysis with software engineering. His work focuses on helping clients discover valuable insights hidden in complex datasets.
 
-    By merging data science with strategic thinking, Alessio consistently delivers solutions that drive measurable business success.
+      By merging data science with strategic thinking, Alessio consistently delivers solutions that drive measurable business success.
 
-- name: Karol
-  image: karol.jpg
-  description_short: |
-    A dedicated data strategist focused on actionable insights and innovative data-driven solutions.
-  description_long: |
-    Karol specializes in developing data-driven strategies tailored to client goals. His keen analytical skills turn raw data into powerful insights.
+  - name: Karol
+    image: karol.jpg
+    description_short: |
+      A dedicated data strategist focused on actionable insights and innovative data-driven solutions.
+    description_long: |
+      Karol specializes in developing data-driven strategies tailored to client goals. His keen analytical skills turn raw data into powerful insights.
 
-    With a background in finance and tech, Karol bridges the gap between complex data sets and meaningful business decisions.
+      With a background in finance and tech, Karol bridges the gap between complex data sets and meaningful business decisions.
 
-- name: Mateusz
-  image: mateusz.jpg
-  description_short: |
-    Passionate about turning complex data into clear, actionable intelligence for better decision-making.
-  description_long: |
-    Mateusz brings expertise in data analytics and process optimization. His focus is on making complex data easy to understand and act upon.
+  - name: Mateusz
+    image: mateusz.jpg
+    description_short: |
+      Passionate about turning complex data into clear, actionable intelligence for better decision-making.
+    description_long: |
+      Mateusz brings expertise in data analytics and process optimization. His focus is on making complex data easy to understand and act upon.
 
-    He thrives on designing solutions that transform insights into competitive advantages, driving client success through precision and clarity.
+      He thrives on designing solutions that transform insights into competitive advantages, driving client success through precision and clarity.

src/_data/tteam.yaml

@@ -0,0 +1,27 @@
+
+- name: Alessio Civitillo
+  image: alessio.jpg
+  description_short: |
+    An experienced financial analyst and software engineer, Alessio brings a unique blend of expertise and vision to the world of data, ensuring that our clients unlock the hidden connections in their data and deliver value to their stakeholders.
+  description_long: |
+    Alessio Civitillo has spent over a decade blending financial analysis with software engineering. His work focuses on helping clients discover valuable insights hidden in complex datasets.
+
+    By merging data science with strategic thinking, Alessio consistently delivers solutions that drive measurable business success.
+
+- name: Karol
+  image: karol.jpg
+  description_short: |
+    A dedicated data strategist focused on actionable insights and innovative data-driven solutions.
+  description_long: |
+    Karol specializes in developing data-driven strategies tailored to client goals. His keen analytical skills turn raw data into powerful insights.
+
+    With a background in finance and tech, Karol bridges the gap between complex data sets and meaningful business decisions.
+
+- name: Mateusz
+  image: mateusz.jpg
+  description_short: |
+    Passionate about turning complex data into clear, actionable intelligence for better decision-making.
+  description_long: |
+    Mateusz brings expertise in data analytics and process optimization. His focus is on making complex data easy to understand and act upon.
+
+    He thrives on designing solutions that transform insights into competitive advantages, driving client success through precision and clarity.

src/admin/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <link rel="dns-prefetch" href="https://unpkg.com">
+    <title>Sveltia CMS</title>
+  </head>
+  <body>
+    <!-- Include the script that builds the page and powers Sveltia CMS -->
+    <script src="https://unpkg.com/@sveltia/cms/dist/sveltia-cms.js" type="module"></script>
+  </body>
+</html>

src/pages/about.njk

@@ -19,7 +19,7 @@ intro: |
     <div class="flow">{{ intro | markdownFormat | safe }}</div>
   </header>
   <article class="feature flow flow-space-l">
-    {% for member in team %}
+    {% for member in team.admin %}
       <div class="about__content flow grid gutter-m" data-layout="50-50">
         {% image "./src/assets/images/team/" + member.image, "" %}
         <div class="flow prose">