Skip to content

Configuration snippets: showing toml, yaml and json format inside tabbed pane#1035

Merged
LisaFC merged 1 commit intogoogle:mainfrom
deining:config_multiple_formats
Jun 1, 2022
Merged

Configuration snippets: showing toml, yaml and json format inside tabbed pane#1035
LisaFC merged 1 commit intogoogle:mainfrom
deining:config_multiple_formats

Conversation

@deining
Copy link
Contributor

@deining deining commented Jun 1, 2022

According to #951, config files will be converted to YAML soon.
In the user guide, currently config file snippets are given in TOML and front matter snippets are mostly given in YAML.
This PR introduces tabbed panes for all configuration snippets listed in the user guide. Insider these tabbed panes, TOML, YAML, and JSON versions for the snippets are presented. This PR also corrects some minor typos and grammatical errors that were found on the way.
An example of such tabbed panes can be found in the Netlify preview of this PR.

@deining deining added the user guide Improvements to user guide label Jun 1, 2022
@deining deining requested a review from LisaFC June 1, 2022 15:48
@deining deining force-pushed the config_multiple_formats branch from 5452912 to d09681b Compare June 1, 2022 15:50
@LisaFC
Copy link
Collaborator

LisaFC commented Jun 1, 2022

This looks really good! Is it ready for merge? I've no suggested changes.

@deining
Copy link
Contributor Author

deining commented Jun 1, 2022

This looks really good! Is it ready for merge?

Yes, it is.

@LisaFC LisaFC merged commit 6801602 into google:main Jun 1, 2022
@deining deining deleted the config_multiple_formats branch June 2, 2022 07:05
fekete-robert pushed a commit to fekete-robert/docsy that referenced this pull request Sep 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

user guide Improvements to user guide

3 participants