Skip to content

Use a better link checker #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/.linkspector.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
dirs:
- .
excludedDirs:
- workflows
- animation
- scripts
aliveStatusCodes:
- 200
- 206
- 403
ignorePatterns:
- pattern: "^https://bazel.build"
- pattern: "^https://makefiletutorial.com"
modifiedFilesOnly: true
replacementPatterns:
- pattern: "<a href=\"https://youtu.be/blah\"></a>"
replacement: "[blah](https://blah.blah)"
9 changes: 0 additions & 9 deletions .github/mcl_config.json

This file was deleted.

11 changes: 7 additions & 4 deletions .github/workflows/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ jobs:
name: All Markdown links are valid
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: gaurav-nelson/github-action-markdown-link-check@v1
with:
config-file: '.github/mcl_config.json'
- uses: actions/checkout@v4
- name: Run linkspector
uses: umbrelladocs/action-linkspector@v1
with:
reporter: github-pr-review
fail_level: any
config_file: .github/.linkspector.yml

check-snippet-compilation:
name: All code snippets compile
Expand Down
2 changes: 1 addition & 1 deletion lectures/compilation_debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Style (🎨) and software design (🎓) recommendations mostly come from [Google
```cmd
c++ -std=c++17 -o test test.cpp
```
- ✅ Enable **most** [warnings](https://gcc.gnu.org/onlinedocs/gcc/gcc-command-options/options-to-request-or-suppress-warnings.html#cmdoption-Wall), treat them as errors:
- ✅ Enable **most** [warnings](https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html#index-Wall), treat them as errors:
`-Wall`, `-Wextra`, `-Wpedantic`, `-Werror`
- Other warnings possible too:
`-Wimplicit-fallthrough`, `-Wsign-conversion`, etc.
Expand Down
2 changes: 1 addition & 1 deletion lectures/cpp_basic_types_and_variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ int main() {

---

# Always initialize all variables! 🚨
# Always initialize all variables!

(unless measured slow, stay tuned to a later point in the course)
<!--
Expand Down
4 changes: 2 additions & 2 deletions lectures/hello_world_dissection.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Hello World!
---
# Here is what we can learn from it

- [Some keywords](hello_world_dissection.md#some-words-and-symbols-are-more-special-than-other-🦄) like `return` or `int` _(and many more!)_
- [Some keywords](hello_world_dissection.md#some-words-and-symbols-are-more-special--than-other) like `return` or `int` _(and many more!)_
- Constants like `"Hello World!"` and `0`
- [Lots of whitespaces!](hello_world_dissection.md#whitespaces-mostly-play-no-role)
- [Different brackets:](hello_world_dissection.md#what-are-all-those-brackets-about) `{}`, `()`, `<>`
Expand All @@ -38,7 +38,7 @@ Hello World!
## 📺 Watch the related [YouTube video](https://youtu.be/t2h1geGSww4)!

---
# Some words and symbols are more special🦄 than other
# Some words and symbols are more special 🦄 than other
- In the code above, some words and symbols are highlighted
- This is done by **parsing** the language into meaningful parts
- Whitespaces and symbols **separate** these parts
Expand Down
3 changes: 2 additions & 1 deletion lectures/templates_why.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Why use templates?
---

<p align="center">
<a href="https://youtu.be/1Mrt1NM3KnI"><img src="https://img.youtube.com/vi/1Mrt1NM3KnI/maxresdefault.jpg" alt="Video" align="right" width=50% style="margin: 0.5rem"></a>
<a href="https://youtu.be/blah"><img src="https://img.youtube.com/vi/blah/maxresdefault.jpg" alt="Video" align="right" width=50% style="margin: 0.5rem"></a>
</p>

- [Why use templates?](#why-use-templates)
Expand All @@ -14,6 +14,7 @@ Why use templates?
- [Compile-time meta-programming](#compile-time-meta-programming)
- [Summary](#summary)

<a href="https://blah/blah"></a>

[Templates](https://en.cppreference.com/w/cpp/language/templates) are definitely one of the features that make C++ so popular and powerful. They provide an extremely versatile mechanism to write truly generic code and allow building meaningful abstractions only paying for these benefits with some compilation time and little to no run time!

Expand Down