Docs: Autocompletion for _config.yml

[pke]

Summary

Create a JSON Schema for publishing at http://schemastore.org so one can get a little help in form of suggestions and validation from supported editors (VSCode) when editing the _config.yaml files.

Would you accept a PR with a JSON Schema?

[DirtyF]

Submit a PR to https://github.com/schemastore/schemastore/pulls and let us know when it's available we'll mention it in our documentation.

[pke]

@DirtyF its available now http://json.schemastore.org/jekyll

I already have a minor fix in the works, but generally it should already work.

[ashmaroli]

baseurl need not be a string. The default value is nil

[pke]

What else can it be? If you don't want to specify it, just don't specify it in the _config.yml. If you however specify it, it must be a valid URI.
Or am I missing something?

[ashmaroli]

If you however specify it, it must be a valid URI.

I just meant to say, the type array for baseurl would be "type": ["string", "null"]

For a site designed to be mounted at URL https://example.com/, the recommended values are null, "" or "/".
For a site designed to be mounted at URL https://example.com/blog/, the recommended values are just "blog", "/blog", or "/blog/"

[pke]

Ok I will add this change. But just to clarify, what would happen if the baseurl is not set at all in your both described URL scenarios?

[ashmaroli]

It defaults to Ruby nil:

jekyll/lib/jekyll/configuration.rb

Line 49 in 6cee922

"baseurl" => nil, # this mounts at /, i.e. no subdirectory

(Since you're working on patch, you should also correct rogue to rouge if not included in the patch already..)

[pke]

I understood that, because I checked the source.

So if the user does not specify it, it will default to nil. No need to include a choice then to set it to nil. Why would you explicitly set it to nil in the config in the first place?

I'll however change the format to be just a string, since "/blog" is not a valid URI.
So the property is in reality more like a "URL base" (to compose relative links) than a base URL ;)

[ashmaroli]

So the property is in reality more like a "URL base" (to compose relative links) than a base URL ;)

Yeah. This property has confused users endless. Some have even interpreted it to be similar to HTML <base />. Internally, the property is used by the Liquid filter relative_url, URL templates and a mounting point for the local dev server.

[pke]

The schema is already live, since... last year ;)
http://json.schemastore.org/jekyll

Feel free to close this here and maybe follow up with a docs note about the schema support? @DirtyF

[DirtyF]

@pke Any guidance on how to use it with VSCode or other editors?

[pke]

Works automagically ;) No tool config required. See the schemastore site for supported editors.

…

-----Original Message----- From: "Frank Taillandier" <notifications@github.com> Sent: ‎10.‎01.‎2020 18:36 To: "jekyll/jekyll" <jekyll@noreply.github.com> Cc: "Philipp Kursawe" <phil.kursawe@gmail.com>; "Mention" <mention@noreply.github.com> Subject: Re: [jekyll/jekyll] Docs: Autocompletion for _config.yml (#7884) @pke Any guidance on how to use it with VSCode or other editors? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or unsubscribe.