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

Audit input-functions.md #59

Merged
merged 1 commit into from
Nov 17, 2021
Merged

Conversation

a-rokay
Copy link
Contributor

@a-rokay a-rokay commented Nov 11, 2021

This PR is an audit of input-functions.md:

  • Add alt text to images
  • Encase key words in backticks
  • Add missing '-'
  • Remove extra indentation from code blocks
  • Add missing comma
  • Remove empty bullet point
  • Add title to frontmatter
  • Improve image centering
  • Add descriptive text to link
  • Add div.mdImg class for image centering

For the image centering, I went with the text-align: center approach which requires the image to be in a div tag. So I combined the existing .mdImg class with a div.mdImg class that does the centering. Because of this, I had to change the span tags in functions.md to div tags. Everything works as expected.

Let me know if I missed anything.

Fixes #33

 * Add alt text to images
 * Encase key words in backticks
 * Add missing '-'
 * Remove extra indentation from code blocks
 * Add missing comma
 * Remove empty bullet point
 * Add title to frontmatter
 * Improve image centering
 * Add descriptive text to link
 * Add div.mdImg class for image centering

Alter CSS for markdown images
 * Combine .mdImg with div.mdImg
 * Use div instead of span in functions.md
Copy link
Contributor

@humphd humphd left a comment

Choose a reason for hiding this comment

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

In #46 we're adding the ideal-image plugin, which will do this image optimization and centering for us, cc @aserputov: can you confirm that I'm correct about this?

I think that we should probably switch to using this everywhere vs. doing our own styling.

@aserputov
Copy link
Contributor

aserputov commented Nov 11, 2021

@a-rokay, that's great work you did here, but as @humphd mentioned above, it's probably better to use the Docusaurus internal plugin ideal image because it provides us with more optimized Images. (responsive, lazy-loading, and low-quality placeholder)

@a-rokay
Copy link
Contributor Author

a-rokay commented Nov 11, 2021

Should I wait for #46 to be merged before continuing?

@humphd
Copy link
Contributor

humphd commented Nov 11, 2021

No, we can do it in #63, just leave a comment there.

@a-rokay
Copy link
Contributor Author

a-rokay commented Nov 14, 2021

I'm not sure what you want me to comment, just that input-functions.md requires ideal-image?

@humphd
Copy link
Contributor

humphd commented Nov 14, 2021

Yes, I don't want to lose track of knowledge, so we need to move unfinished work items forward into new or existing issues before we close things.

@a-rokay
Copy link
Contributor Author

a-rokay commented Nov 14, 2021

Got it, should I remove the image centering and CSS from this PR?

@humphd
Copy link
Contributor

humphd commented Nov 16, 2021

@a-rokay you can include it, but later we need to update all our uses of it.

@a-rokay a-rokay requested a review from humphd November 16, 2021 16:06
@CameronGray1210 CameronGray1210 merged commit b7491f7 into Seneca-ICTOER:main Nov 17, 2021
@CameronGray1210
Copy link
Collaborator

Great Job many thanks!

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.

Audit and Fix input-functions.md
4 participants