search

AguaClara / aide_document-DEPRECATED

This module is no longer being maintained due to the transition to Onshape.
MIT License
0 stars 0 forks source link

A Radical Shift to Markdown and Jekyll #14

Closed eak24 closed 6 years ago

eak24 commented 6 years ago

Hi @AguaClara/aide_document,

I recently re-discovered an extremely relevant post about jekyll (a powerful static site generator). It talks about how you can add data files to your site and then reference them through variable names! And the data files can be json! I am strongly in favor of switching to markdown anyways, and this addin might just do the work for us. Let's talk about this next semester.

eak24 commented 6 years ago

An update... Looks like the JinJa templating engine is Python's native templating engines. Apparently there is a whole world of templating engines out there... see this wiki on them. With Jinja, we can make markdown files and use Jinja to intelligently inject variables, renderings, photos, etc...

eak24 commented 6 years ago

hi @AguaClara/aide_document,

Please see the above ^ . Before jumping straight into Jekyll, I want to recommend a good long look at Jinja, which is Flask's templating engine. It is essentially Jekyll's liquid templating, but built in Python. We're using it currently to design the plants, and I think it may be easier if we were to use the same templating engine throughout the hole AIDE ecosystem. Here's a quick primer. Could someone make a comparison of the pros and cons for Jinja v. Liquid (Jekyll's system).

eak24 commented 6 years ago

It would be the latest Jinja... Jinja2

eak24 commented 6 years ago

Specifically, this should be a comparison between the two templating engines, Liquid and Jinja. No need to discuss Jekyll and Flask, which both have a number of other technologies built in, Jekyll being the Ruby-based version of Flask.

asagarasu commented 6 years ago

Hello, Ethan! The team have discussed the issue today and have come up the following comparison document. I believe the main problem of Flask is it might be hard to host it on Github. https://docs.google.com/document/d/1NhgZ1ZO001flTBN056bm6hvfqBAN13Lz9Rj672Zrbi8/edit?usp=sharing

eak24 commented 6 years ago

@urielAnneliese thanks for the update! I have two comments. The first is that Jinja is not flask, and Liquid is not Jekyll. Liquid and Jinja are templating engines, whereas Flask and Jekyll are static site generators (well, technically flask isn't) that use the templating engines. Any set of static files can be hosted on Github, and I can show you how. It is just as simple to host the generated html from Flask as it is from Jekyll directly on Github-pages. We should talk soon to discuss this. @matanp could you send me a calendar invite for when the team can have a meeting?