Skip to content

Fix redundant HTML #819

@codekansas

Description

@codekansas

Re #818

Turns out there's a lot of repeated things that are kind of a mess to maintain. I was thinking that a good way to unify the "text-heavy" parts of this project would be to use something like Jekyll, so that the texts of like the "about" parts could be written first in Markdown then built to HTML, which would be much cleaner than just writing everything in HTML (as it currently stands). For example, disclaimers and stuff that is used frequently throughout multiple apps could be written once, so that if they have to be updated somewhere down the line it is cleaner / safer than running some complicated grep. For example, you can put peoples' emails in a yaml file so that they can be updated / referenced more easily...

The Jekyll stuff wouldn't add very much technical complexity / likelihood of breaking things, since it's just a static markdown renderer (i.e. renders to HTML templates). Design would be something like:

Add a subdirectory in the project devoted to static includes (i.e. jekyll-templates/) with two subdirectories, src/ and generated/. Put all the Jekyll text in the src/ directory. Add the generated/ directory as a Django template location. When Jekyll stuff gets changed, run the command

jekyll build --source src/ --destination generated/

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions