scala / scala-lang

sources for the Scala language website
https://scala-lang.org
Other
274 stars 320 forks source link

use GitHub Flavored Markdown #526

Open SethTisue opened 7 years ago

SethTisue commented 7 years ago

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 commented 7 years ago

:+1:

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 commented 7 years ago

👍 Agree!

muskan3006 commented 3 years ago

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

eed3si9n commented 3 years ago

@muskan3006 Looking at _config.yml - https://github.com/scala/scala-lang/blob/2c1afd55f6289839e26d58a8b956f5e6ba0e0af5/_config.yml#L7-L8

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 commented 3 years ago

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

muskan3006 commented 3 years ago

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