Website/generator #618
Draft
Website/generator #618
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
PGijsbers
added
Documentation
PGijsbers
commented
Sep 3, 2024
| class NavigationItem(NamedTuple): | ||
| name: str | ||
| url: str | ||
| icon: str |
There was a problem hiding this comment.
Suggested change
| icon: str | |
| icon: Path |
|
|
||
| def generate_navigation_for(items: list[NavigationItem], mobile: bool = False) -> str: | ||
| # TODO: Add outlink icon | ||
| item_template = "<a href=\"URL\" class=\"nav-link nav-icon\">NAME_OR_ICON</a>" |
There was a problem hiding this comment.
Use string formatting with variable names to make this less prone to errors if changed (replace doesn't raise an error if the term doesn't exist in the string)
Comment on lines
17
to
21
| with open(item.icon, "r") as fh: | ||
| icon = fh.read() | ||
|
|
||
| name_or_icon = icon if (mobile or item.icon_only) else item.name | ||
| nav_html = item_template.replace("URL", item.url).replace("NAME_OR_ICON", name_or_icon) |
There was a problem hiding this comment.
don't load file if it's not used
| documentation: str = None | ||
|
|
||
|
|
||
| def load_framework_definitions(definition_file: Path = Path("official_frameworks.toml")) -> list[Framework]: |
There was a problem hiding this comment.
don't read and process in the same function, makes it hard to test
|
|
||
|
|
||
| def load_footer() -> str: | ||
| with open("templates/footer.html", "r") as f: |
There was a problem hiding this comment.
replace string with defined constant.
why are some templates in files and others hard-coded?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Working on some simple scripts which help generate the website, which will make it easier to add frameworks and pages in the future.