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

added plugin support for relative links and make fixes/updates to other .md files #405

Merged
merged 12 commits into from
May 22, 2024

Conversation

kmoscoe
Copy link
Contributor

@kmoscoe kmoscoe commented May 20, 2024

This change adds support for a relative links plug-in (https://github.com/benbalter/jekyll-relative-links/blob/main/README.md), which otherwise don't work in Github Pages sites.

In addition, made the following changes to the readme files:

  • Added a link to Kramdown docs
  • Fixed broken link from readme to contributing file
  • Fixed incorrect link to Google dev style guide
  • Added some background info on how the site is hosted and generated and navigation bar.
  • Added some text to the style guide to explain how to do non-obvious things like linking and TOCs
  • Added a tip for running the site locally with an alternate IP address
  • Cleaned up the contributing instructions to not use hard-coded variables
  • Edited to use actual Google dev style guide requirements like sentence case everywhere, uppercase, italicized variable names, etc.

README.md Outdated Show resolved Hide resolved
@kmoscoe kmoscoe requested a review from beets May 20, 2024 19:32
Copy link
Contributor

@beets beets left a comment

Choose a reason for hiding this comment

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

Thanks for these updates!

Could you also please add more context to the PR description?

Gemfile Show resolved Hide resolved
README.md Show resolved Hide resolved
@kmoscoe kmoscoe changed the title added plugin support for relative links added plugin support for relative links and make fixes/updates to other .md files May 20, 2024
@beets
Copy link
Contributor

beets commented May 20, 2024

thanks for the update. i think you need to push your changes to your remote branch.

for this and future PR's, please add the "why" for the change to the PR description.

@kmoscoe
Copy link
Contributor Author

kmoscoe commented May 20, 2024 via email

@kmoscoe
Copy link
Contributor Author

kmoscoe commented May 20, 2024 via email

Copy link
Contributor

@beets beets left a comment

Choose a reason for hiding this comment

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

thanks for the fixes!

@kmoscoe kmoscoe merged commit 1a996a4 into datacommonsorg:master May 22, 2024
1 check passed
@kmoscoe kmoscoe deleted the relative_links branch May 28, 2024 22:43
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