chore: add markdownlint / prettier

in much the same was as in the 'program' repo

Author: rvedotrc

.gitbook/assets/education-career-journey.json

@@ -0,0 +1,4 @@
+.DS_Store
+.idea
+.vscode
+node_modules/

.gitignore

@@ -0,0 +1,14 @@
+---
+$schema: https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.38.0/schema/markdownlint-config-schema.json
+extends: markdownlint/style/prettier
+no-trailing-punctuation:
+  punctuation: .,;:。，；：！
+no-inline-html: false
+code-block-style:
+  style: fenced
+search-replace:
+  rules:
+    - name: plain-spaces
+      message: "hard spaces are not allowed"
+      searchPattern: "/(?![ \\n])\\s/g"
+      replace: " "

.markdownlint.yaml

@@ -0,0 +1,3 @@
+{
+  "endOfLine": "lf"
+}

.prettierrc

@@ -0,0 +1 @@
+nodejs 24.10.0

.tool-versions

@@ -14,17 +14,17 @@ You can find all the information you'll need to become a great HackYourFuture me
 
 ## Why join the HackYourFuture Community?
 
-* You will contribute to improving the lives of others through tech training 🚀
-* You will become a better expert of your own craft by teaching your knowledge 🤓
-* You will be exposed to different cultures and different ways of thinking & working 👐
-* You will become a part of HackYourFuture’s professional network (nearly 1k members!) 🌐
+- You will contribute to improving the lives of others through tech training 🚀
+- You will become a better expert of your own craft by teaching your knowledge 🤓
+- You will be exposed to different cultures and different ways of thinking & working 👐
+- You will become a part of HackYourFuture’s professional network (nearly 1k members!) 🌐
 
 ## What do we stand for at HackYourFuture?
 
-* Together, we speak the same language: English 💬.
-* We work together on Sundays 🌤. We're adapted to our trainees realities, facing other challenges during the weekdays.
-* We breathe openness 👐. We're fully transparent and happy to share our methods and progress.
-* We help you let your future define you, not your past 💪. We train asylum seekers, refugees and others facing barriers to the Danish job educational system and job market.
-* We work to get our trainees into their tech job, not to just graduate our program. 💼
-* We are like a family 🧡. Our format is based on a grassroots community with volunteer coaches and mentors.
-* We advocate for diversity 🧕. We strongly encourage women to participate. Over 50% of our trainees are women.
+- Together, we speak the same language: English 💬.
+- We work together on Sundays 🌤. We're adapted to our trainees realities, facing other challenges during the weekdays.
+- We breathe openness 👐. We're fully transparent and happy to share our methods and progress.
+- We help you let your future define you, not your past 💪. We train asylum seekers, refugees and others facing barriers to the Danish job educational system and job market.
+- We work to get our trainees into their tech job, not to just graduate our program. 💼
+- We are like a family 🧡. Our format is based on a grassroots community with volunteer coaches and mentors.
+- We advocate for diversity 🧕. We strongly encourage women to participate. Over 50% of our trainees are women.

README.md

@@ -1,25 +1,25 @@
 # Table of contents
 
-* [Mentor's Guide](README.md)
-  * [🎯 Getting Started](master/getting-started.md)
-  * [📕 Glossary](master/glossary.md)
+- [Mentor's Guide](README.md)
+  - [🎯 Getting Started](master/getting-started.md)
+  - [📕 Glossary](master/glossary.md)
 
 ## Roles
 
-* [💻 Technical Mentors](roles/technical-mentors/README.md)
-  * [Assignment Reviewer](roles/technical-mentors/homework-reviewer.md)
-  * [Session Assistant](roles/technical-mentors/teaching-assistant.md)
-  * [Session Lead](roles/technical-mentors/lead-teacher.md)
-  * [Flexible tasks](roles/technical-mentors/flexible-tasks.md)
-* [📈 Career Mentors](roles/career-mentors/README.md)
-  * [Jobseeker Toolkit](roles/career-mentors/jobseeker-toolkit.md)
-  * [Interview Training](roles/career-mentors/interview-training/README.md)
-    * [Mock-HR Interview](roles/career-mentors/interview-training/mock-hr-interview.md)
-    * [Mock-Technical Interview](roles/career-mentors/interview-training/mock-technical-interview.md)
-    * [Live-coding Interview](roles/career-mentors/interview-training/live-coding-interview.md)
-  * [1:1 Career Coach](roles/career-mentors/1-1-career-coach.md)
+- [💻 Technical Mentors](roles/technical-mentors/README.md)
+  - [Assignment Reviewer](roles/technical-mentors/homework-reviewer.md)
+  - [Session Assistant](roles/technical-mentors/teaching-assistant.md)
+  - [Session Lead](roles/technical-mentors/lead-teacher.md)
+  - [Flexible tasks](roles/technical-mentors/flexible-tasks.md)
+- [📈 Career Mentors](roles/career-mentors/README.md)
+  - [Jobseeker Toolkit](roles/career-mentors/jobseeker-toolkit.md)
+  - [Interview Training](roles/career-mentors/interview-training/README.md)
+    - [Mock-HR Interview](roles/career-mentors/interview-training/mock-hr-interview.md)
+    - [Mock-Technical Interview](roles/career-mentors/interview-training/mock-technical-interview.md)
+    - [Live-coding Interview](roles/career-mentors/interview-training/live-coding-interview.md)
+  - [1:1 Career Coach](roles/career-mentors/1-1-career-coach.md)
 
 ## Practicalities
 
-* [📍 Location: Copenhagen](practicalities/location.md)
-* [📍 Location: Aarhus](practicalities/location-aarhus.md)
+- [📍 Location: Copenhagen](practicalities/location.md)
+- [📍 Location: Aarhus](practicalities/location-aarhus.md)

SUMMARY.md

@@ -0,0 +1,57 @@
+#!/bin/bash
+
+set -eu
+
+markdownlint() {
+  echo "markdownlint: RUN"
+  if npm exec -- markdownlint --ignore 'node_modules/' --rules markdownlint-rule-search-replace '**/*.md' ; then
+    echo "markdownlint: PASS"
+  else
+    echo "markdownlint: FAIL"
+    return 1
+  fi
+}
+
+prettier() {
+  echo "prettier: RUN"
+  if npm exec -- prettier --check . ; then
+    echo "prettier: PASS"
+  else
+    echo "prettier: FAIL"
+    return 1
+  fi
+}
+
+lint-git-tree() {
+  echo "lint-git-tree: RUN"
+  if npx @blaahaj/lint-git-tree ; then
+    echo "lint-git-tree: PASS"
+  else
+    echo "lint-git-tree: FAIL"
+    return 1
+  fi
+}
+
+all() {
+  local rc=0
+  echo "lint: RUN"
+  markdownlint || rc=1
+  prettier || rc=1
+  lint-git-tree || rc=1
+
+  if [ $rc -eq 0 ] ; then
+    echo "lint: PASS"
+  else
+    echo "lint: FAIL"
+    echo "Try './lint --fix' to see if any automatic fixes are possible"
+  fi
+
+  return $rc
+}
+
+if [ "${1:-}" == "--fix" ] ; then
+  npm exec -- markdownlint --ignore 'node_modules/' --rules markdownlint-rule-search-replace --fix '**/*.md' || :
+  npm exec -- prettier --write --list-different . || :
+else
+  all
+fi

lint

@@ -10,17 +10,17 @@ Our Slack workplace is the **main communication tool we use**. The workspace has
 
 ## FAQ
 
-* Q: **How long do I have to commit as a volunteer?**\
+- Q: **How long do I have to commit as a volunteer?**\
   A: The duration of the module you are helping out with. ([see below](https://mentor.hackyourfuture.dk/getting-started#so-how-is-the-curriculum-structured)) However, there is no limitation to how many modules you want to be part of. 
-* Q: **How much time does mentoring require per week?**\
+- Q: **How much time does mentoring require per week?**\
   A: It depends on the role, but aim at about 7-8 hours per week.
-* Q: **Do I need to be a working professional to teach?**\
+- Q: **Do I need to be a working professional to teach?**\
   A: No, you don't need to be a working professional, but it is a big plus. We want our trainees to learn from people who work with the technologies in our curriculum on a daily basis and know the challenges of the market.
-* Q: **Will I be leading the workshops all by myself?**\
+- Q: **Will I be leading the workshops all by myself?**\
   A: No, the sessions are always run by a small group of volunteers. This allows for less pressure on the individual, split responsibility, and a broader perspective for our trainees.
-* Q: **Do I have to teach exactly like it says in the curriculum?**\
+- Q: **Do I have to teach exactly like it says in the curriculum?**\
   A: Not strictly. We have a clear curriculum with set learning goals and examples. The learning goals are the most important outcomes that you must help trainees reach by the end of the module. However, how you approach teaching those, specific materials you introduce or new ideas for exercises are always welcomed. Our curriculum is open-source, so you are welcome (and strongly encouraged!) to contribute to it with your own ideas. Check out our [Contributing guide](https://github.com/HackYourFuture-CPH/programme/tree/main/contributing), if you're interested.
-* Q: **When do the workshops take place?**\
+- Q: **When do the workshops take place?**\
   A: Sundays 12:00 - 16:00
 
 ## So how is the program structured?
@@ -37,11 +37,11 @@ As a mentor you can book a specific module where you are responsible for the tea
 
 ## Modules
 
-* All modules have their own directory in the [Program repo](https://github.com/HackYourFuture-CPH/programme).
-* Check out the overview Readme under each course to see more details about the modules and content covered. Start [here](https://github.com/HackYourFuture-CPH/programme/tree/main/courses) if you want to look around.
-* We divided everyone in our organization into GitHub teams, we have one for mentors, one for each trainee team etc. which all have different permissions.
-* We have a private repository where fellow mentors share their [**teaching-tips-and-tricks**](https://github.com/HackYourFuture/teaching_tips_tricks), if you are new to teaching or are just curious on what they think works well in team, take a look.
-* Please contribute and help improve the curriculum. Just make a Pull Request or share your feedback in slack ([#curriculum-crew](https://hackyourfuture-cph.slack.com/archives/C070USK1UET) is a good place to start).
+- All modules have their own directory in the [Program repo](https://github.com/HackYourFuture-CPH/programme).
+- Check out the overview Readme under each course to see more details about the modules and content covered. Start with [Courses](https://github.com/HackYourFuture-CPH/programme/tree/main/courses) if you want to look around.
+- We divided everyone in our organization into GitHub teams, we have one for mentors, one for each trainee team etc. which all have different permissions.
+- We have a private repository where fellow mentors share their [**teaching-tips-and-tricks**](https://github.com/HackYourFuture/teaching_tips_tricks), if you are new to teaching or are just curious on what they think works well in team, take a look.
+- Please contribute and help improve the curriculum. Just make a Pull Request or share your feedback in slack ([#curriculum-crew](https://hackyourfuture-cph.slack.com/archives/C070USK1UET) is a good place to start).
 
 ## Workshops/Master Classes
 

master/getting-started.md

@@ -11,10 +11,12 @@ You may still find traces of the outdated terms. How you can help the transition
 
 1. Please update outdated terms if you spot them anywhere, or raise them to a staff member.
 2. If you hear people use any outdated terms, feel free to kindly nudge them towards the new terms (or point them to this page for clarification).
-{% endhint %}
+   {% endhint %}
 
 ## Definitions
 
+<!-- markdownlint-disable no-emphasis-as-heading -->
+
 ### Assignments
 
 _(Previously "Homework")_
@@ -78,3 +80,5 @@ _See_ [_Curriculum (GitHub)_](https://github.com/HackYourFuture-CPH/curriculum)
 ### Module
 
 A unit of the Curriculum that focuses on a specific theme e.g. "JavaScript".
+
+<!-- markdownlint-enable no-emphasis-as-heading -->