jadelet icon indicating copy to clipboard operation
jadelet copied to clipboard

Add a language specification, guide and/or tutorial.

Open ciuncan opened this issue 10 years ago • 8 comments

Correct me if I am wrong, but I couldn't find a guide to language features after taking some time googling. Having a document telling about how to write a template, whether we need an accompanying coffeescript file or not and such would be real nice.

ciuncan avatar Jun 17 '14 10:06 ciuncan

Have you seen the getting started section of the README? https://github.com/dr-coffee-labs/hamlet#getting-started

There is also a widget page, showing how some simple templates and models interact. http://hamlet.coffee/garden/

If those are still too vague, we'll be adding a few tutorial videos this week.

mdiebolt avatar Jun 20 '14 00:06 mdiebolt

Yes I have seen that, well, it explains pretty much how to use it. I also understand that there are many nice examples that help developers grasp how things work, but I believe it is still necessary to have a language specification that explains the syntax of template language, available tags; in short, how things maps to html. Thanks.

ciuncan avatar Jun 20 '14 10:06 ciuncan

Let me be concrete about my confusion. I am a professional Python programmer with very little background in javascript or nodejs. I looked at the website and decided to learn hamlet. So after getting it install I did indeed go through the README. That led to me installing browserify because it looked like the cleaner more powerful approach to using hamlet. But it is not clear how to take a simple hamlet example (like the one on the frontpage at hamlet.coffee) and turn that into a browserify project that I can then view in my browser.

Ideally such a complete example would be right in this source repo.

metaperl avatar Jun 21 '14 13:06 metaperl

Thanks cluncan and metaperl for the additional details. We're currently working on a much better "Getting Started" example and tutorial section in addition to some sample apps. We'll update this issue with links to it soon. Thanks for the feedback!

STRd6 avatar Jun 21 '14 14:06 STRd6

Here's the beginning of the spec, more to come: https://gist.github.com/STRd6/ac81a3afb5a8d00e02a6

STRd6 avatar Jul 09 '14 20:07 STRd6

+1 docs definetely should be available. I started some pet project with hamlet, but it's very annoying to discover possibilities by trying it in code and debugging errors sometimes..

The spec you provided is very rough and not updating for a long time. I would not recommend hamlet for anyone to use in the projects before some spec and documentation will be available and describe all APIs, tags and possibilities with peculiarities as well.

voronianski avatar Jul 20 '14 07:07 voronianski

+1

For someone like me who has never used coffee script it is especially hard to recognize what is specific to hamlet and what is coffee script. This makes starting very rocky

barbalex avatar Jul 20 '14 22:07 barbalex

https://jadelet.glitch.me/ is another good place, more coming soon:tm:

STRd6 avatar Jul 03 '19 23:07 STRd6