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

Create specification for required config variables #41

Closed
20 tasks done
Descent098 opened this issue May 17, 2022 · 0 comments
Closed
20 tasks done

Create specification for required config variables #41

Descent098 opened this issue May 17, 2022 · 0 comments

Comments

@Descent098
Copy link
Owner

Descent098 commented May 17, 2022

Reasoning

Example

required_config:
  avatar:
    type: str
    default: "https://example.com"
    description: "This is a link to an avatar image"

This would mean when using the theme to init a project there will be the following parameters added to config.yml

... # Other code
avatar: "https://example.com" # This is a link to an avatar image
...

Requirements

  • Ability to specify required variable, if no type is specified str is assumed
  • implement functionality for other attributes
    • Default
    • Description
  • Implement sensible defaults for attributes (default and description)
  • Allow for description to not be required
  • allow for default to not be required
  • Check in ezcv.core.generate_site() before generating
  • Use in ezcv.cli.init() when generating config.yml
  • ignore name and theme
  • Add to existing themes
    • Dimension
    • Qu-UP ezcv themes

Docs

  • Guide for creating your own theme with this included
  • Adding a notice that this won't generate when using ezcv theme -m
  • Document behaviour when default or description is not provided
  • Document behaviour for default and description
    • Default is used in site generation as the default value in config.yml
    • Description is added as a comment after default
    • ignores name and theme
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant