marcusolsson/edith

An open learning platform based on Gatsby

Hi, I'm Marcus 👋

I'm a Developer Educator at AssemblyAI, who help developers build things.

Here are some other places you can find me on the internet:

• Website
• LinkedIn
• Mastodon

Show your support ☕️

If I've made something that was helpful or useful to you, you can buy me a coffee to show your support ☕️

You can also find me on Mastodon.

edith's Issues

Internal links in Markdown content are broken

The "Formatting text with markdown" link on this page is broken.

Actual:
https://marcusolsson.github.io/modules/formatting-text/

Expected:
https://marcusolsson.github.io/edith/en/modules/formatting-text/

Search modules and courses

As a learner, I'd like to be able to quickly find the content I'm looking for.

Suggestion:

A search bar at the top of the default layout that autocompletes to modules and courses.

Add shortcut for copying code

Code blocks should have a shortcut to copy the code without having to select it.

Examples:

Add support for "pinning" featured content

For large catalogs of modules and courses, you may want to let new users know where to start their journey.

By pinning modules and courses, they'd show up in a featured area on the front page.

---
type: course
pinned: true
---

Convert to a Gatsby theme

Currently, Edith is a Gatsby starter which, when installed, no longer maintains a connection with the original source.

By converting Edith into a Gatsby theme, users will be able to install Edith as a package. It also means that we can start creating new starters with different look-and-feels.

If you have experience converting a Gatsby starter into a theme, I'd love your help!

Add support for quizzes

Modules should have a way to let the learner reinforce what they've just learned.

The educator should be able to define simple forms with inputs like:

• Text fields
• Radio buttons
• Checkboxes

There seems to be some ideas around defining forms in Markdown, such as:

Name: ___

Favorite animal:
- ( ) Cat
- ( ) Dog

Competencies:
- [ ] Programming
- [ ] Public speaking

Another solution would be to import a Quiz JSX component with MDX.

## Test your skills

Put what you've learned to the test:

<Quiz>
  <RadioGroup>
    <FormControlLabel value="cat" control={<Radio />} label="Cat" />
    <FormControlLabel value="dog" control={<Radio />} label="Dog" />
  </RadioGroup>
</Quiz>

How are folders handled?

The content folder quickly gets cluttered, so folders are necessary. How are these supposed to be handled? At the moment they can be seen in the URL. If a course is in a folder, how do I reference the modules properly?

Style and margin for blockquote

The margin-bottom for the paragraph inside should be 0.

Maybe a personal preference, but should it also be cursive? I like the style Medium uses for their blockquotes.

Redirection on module completion

Currently, when a module is completed, you're redirected to /. If this module is in a course, the wanted behaviour with be either:

• Begin next module in course
• Redirect back to course page

Add support for image logos

Right now the "logo" is the site title.

It should be possible to configure Edith to use an image logo as well.

Add support for math

Edith should support writing math equations in modules:

For example:

Lift($L$) can be determined by Lift Coefficient ($C_L$) like the following equation.

$$
L = \frac{1}{2} \rho v^2 S C_L
$$

would generate something like:

There seems to be a remark plugin for this: https://github.com/remarkjs/remark-math that we should look at.

"How to use" in README

Gatsby noob here - do I use it as a theme or how do I approach this? Or is it a starter?

Remove zero indexing in the URL

When on the first step, the URL says it is step 0 etc. Always 1 off. It should be the same number as the step.

Add support for conditional instructions

For scenarios where there are multiple ways to accomplish a certain task, there should be a way to define conditional tasks.

For example, when:

• you can download the source code in multiple ways, i.e. npm, go get, zip file, etc.
• you can connect to multiple databases

Here's an example from the Google Cloud docs.

Another example from the Hugo docs:

List items have inconsistent styling

List items with nested elements are styled differently then simple lists:

- First item
- Second item
  Nested item

results in the following HTML:

<ul>
  <li>
    First item
  </li>
  <li>
    <p class="MuiTypography-root MuiTypography-body1 MuiTypography-paragraph">Second item</p>
    <p class="MuiTypography-root MuiTypography-body1 MuiTypography-paragraph">Nested item</p>
  </li>
</ul>

Deploys from GitHub Actions breaks images and links

Deploying from GitHub Actions:

Breaks images

#4

Breaks links

https://marcusolsson.github.io/edith/en/modules/formatting-text/

becomes

https://marcusolsson.github.io/edith/en/edith/modules/formatting-text/

Add support for drafts

Allow authors work on new content without blocking changes to content that's already been published.

Suggestion:

Add a draft property to the front matter. If set to true, content will be visible during development, but hidden in production.

---
draft: true
---

Image isn't being loaded

Image don't seem to work when published to GitHub Pages. Works locally.