Skip to content
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

Fix links in README when rendered to github pages and other fixes/cleanup #110

Merged
merged 5 commits into from
Aug 16, 2024

Conversation

Ortonix
Copy link
Contributor

@Ortonix Ortonix commented Aug 10, 2024

Description:

Resolve Issue #109

I have deployed the edited code here so changes can be previewed live (original for comparison).

  • Convert html links to markdown so they render back into html properly when being deployed to github-pages
    • This is needed so that a link to FAQ.md is detected and changed to link to the generated FAQ.html
  • Fix list indenting to fit github markdown formatting rules
    • This one was a bit more odd - it seems that github pages uses a different markdown interpreter that takes a 4 space indent (beyond the level of the list) as a code block, which is why random parts of the BOM are currently showing as code blocks. This is now fixed.
    • I have kept indenting to 2 space tab stops to make editing easier.
  • Add meaningful alt text to image links (where link was markdown)
  • Change as much html to markdown as possible
    • Some html is used to centre items on the page and to constrain width of images this is not something markdown can do.
    • Image sizes should be set by uploading an image of the correct dimensions. This is out of scope of this PR.
  • Tidy up markdown formatting
    • Blank lines around headers and lists
    • Remove trailing whitespace (except where needed)
    • Use _ for italics
  • Add heading to FAQ

There may be a couple of conflicts between this and my other PR, but they will be easily resolved.

- convert all other unneeded html to markdown (left in centering and image attributes)
- tidy up markdown formatting
- hopefully fix some issues with the github pages conversion (will see when the deployment runs I guess?)
make all links within repo relative.
Copy link
Collaborator

@AJ-Koenig AJ-Koenig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - waiting for conflicts to be resolved.

@Ortonix
Copy link
Contributor Author

Ortonix commented Aug 16, 2024

Conflicts resolved and checked for issues on deployment here

Fixed one broken link.

@AJ-Koenig AJ-Koenig merged commit 7617794 into KinkyMakers:master Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants