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

Give a comprehensive config.json example in the docs #139

Open
joanise opened this issue Dec 16, 2022 · 0 comments
Open

Give a comprehensive config.json example in the docs #139

joanise opened this issue Dec 16, 2022 · 0 comments

Comments

@joanise
Copy link
Member

joanise commented Dec 16, 2022

For someone who does not already know how to write json, it's not intuitive how to combine the different things we say you can add to our config.json file, by just reading the documentation at https://readalong-studio.readthedocs.io/en/latest/cli-guide.html#adding-titles-images-and-do-not-align-segments-via-the-config-json-file

There is already such an example, we should just make it more complete by also adding title, header and subheader to it, since that and images are going to be commonly combined.

And, there's a typo:

            "0": "image-for-page1.jpg",
            "1": "image-for-page1.jpg",
            "2": "image-for-page2.jpg",
            "3": "image-for-page3.jpg"

should be

            "0": "image-for-page1.jpg",
            "1": "image-for-page2.jpg",
            "2": "image-for-page3.jpg",
            "3": "image-for-page4.jpg"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant