MarkBind / markbind

MarkBind is a tool for generating content-heavy websites from source files in Markdown format
https://markbind.org/
MIT License
134 stars 123 forks source link

Include link to the migrated AB3 website on our showcase #2517

Closed tlylt closed 2 months ago

tlylt commented 2 months ago

What is the purpose of this pull request?

Overview of changes: Fixes #2072

Anything you'd like to highlight/discuss: If the AB3 website is defaulted to use MarkBind in the future, we should update this link.

Testing instructions: https://deploy-preview-2517--markbind-master.netlify.app/showcase

Proposed commit message: (wrap lines at 72 characters) Include link to the migrated AB3 website on our showcase


Checklist: :ballot_box_with_check:


Reviewer checklist:

Indicate the SEMVER impact of the PR:

At the end of the review, please label the PR with the appropriate label: r.Major, r.Minor, r.Patch.

Breaking change release note preparation (if applicable):

Give a brief explanation note about:

  • what was the old feature that was made obsolete
  • any replacement feature (if any), and
  • how the author should modify his website to migrate from the old feature to the replacement feature (if possible).
tlylt commented 2 months ago

I think one thing to consider is there seems to be a (visual only) bug on this website haha

Interesting & keen observations @kaixin-hc 👀

There are two cases here because the sidebar content for UG and DG are different. For UG the sidebar items are actually different pages, for DG they are anchor links to the same DG page.

(a) for User Guide of the ab3-m website

(b) for DG of the ab3-m website


It is also a little strange that the subsite embedded/linked in se-education.org is se-education.org/addressbook-level3

The current default is the Jekyll version so it should be the one linked in se-education.org. The MarkBind version is an alternative, there's a guide in the se-edu here and instructions given to students here image

kaixin-hc commented 2 months ago

@KevinEyo1 fixed a similar bug recently on #2396 , maybe you can weigh in?


I think you sent the wrong link for instructions to students? But okay, makes sense then to have both websites to show people two alternatives.

KevinEyo1 commented 2 months ago

Hi, I did fix this bug on #2400. I just moved the relevant files under a new directory so that it can accurately track the right tab

Navbar: image

Shifting of files under new directory: image

tlylt commented 2 months ago

Hi, I did fix this bug on #2400. I just moved the relevant files under a new directory so that it can accurately track the right tab

Navbar:

image

Shifting of files under new directory:

image

I see... in that case it's not a bug:) it depends on how users arrange their files