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

Fix redundant HTML #819

Open
codekansas opened this issue Feb 1, 2018 · 0 comments
Open

Fix redundant HTML #819

codekansas opened this issue Feb 1, 2018 · 0 comments

Comments

@codekansas
Copy link
Contributor

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/
@hdoupe hdoupe changed the title Fix redundant HTML stuff Fix redundant HTML Feb 2, 2018
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