docs.scala-lang icon indicating copy to clipboard operation
docs.scala-lang copied to clipboard

New Scaladoc static site gen - Add a mention to the provided Liquid variables

Open JD557 opened this issue 3 years ago • 2 comments

I think it's a bit odd that the documentation specifies "[...] several custom filters and tags specific to Scala[...]" and then doesn't mention anything about that.

From what I can tell from the source code, the only Scala specific things being provided are the projectTitle and projectVersion.

I think it's useful to document the existence of this variables. Especially projectVersion, which can be used to automatically generate sbt/mill/maven/... coordinates.

JD557 avatar Sep 17 '22 22:09 JD557

@pikinier20 perhaps you know more about which liquid variables are available in the new scaladoc

bishabosha avatar Sep 20 '22 08:09 bishabosha

Tbh I don't know. I guess it's some standard set. FYI we are using Jekyll flavor: https://github.com/lampepfl/dotty/blob/cf4dd05433c4d3866e86a55063791b57f7a5e278/scaladoc/src/dotty/tools/scaladoc/site/templates.scala#L116 .

pikinier20 avatar Sep 20 '22 10:09 pikinier20