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

use GitHub Flavored Markdown #526

Open
SethTisue opened this issue Nov 12, 2016 · 6 comments
Open

use GitHub Flavored Markdown #526

SethTisue opened this issue Nov 12, 2016 · 6 comments

Comments

@SethTisue
Copy link
Member

over at https://github.com/scala/scala.github.com/blob/master/_config.yml we have:

markdown: kramdown
kramdown:
  input: GFM

it would be great to standardize on the same thing here. for multiple reasons:

  1. GitHub Flavored Markdown is IMO what our contributors are likeliest to expect
  2. it's confusing and error-prone for contributors anytime the two sites have technical differences (and makes it harder to move content between the two sites)
@jarrodu
Copy link
Member

jarrodu commented Nov 12, 2016

👍

As a side note on your second point it also makes sense to me to have both site have the same production environment. This would make errors easier to reason about and easier to fix.

@heathermiller
Copy link
Member

👍 Agree!

@muskan3006
Copy link

Hey, do you still need help here? if yes can you please brief me what needs to be done here? thanks

@eed3si9n
Copy link
Member

@muskan3006 Looking at _config.yml -

markdown: kramdown
highlighter:

it doesn't say

markdown: kramdown
kramdown:
  input: GFM

so I think we still need help on this task.

Here's what is likely needed.

step 1

Follow readme (https://github.com/scala/scala-lang) to setup a local environment to build scala-lang.org using the exact version of Jekyll etc.

step 2

Change _config.yml and add:

kramdown:
  input: GFM

step 3

Manually go through the pages to see if the rendering looks different from https://scala-lang.org/, and fix them appropriately. If there's no one-to-one feature available for some reason, let us know here.

@SethTisue
Copy link
Member Author

@muskan3006 that'd be awesome! I agree with Eugene's assessment.

@muskan3006
Copy link

@eed3si9n thanks for briefing, I'll have a look soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants