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

Add a language specification, guide and/or tutorial. #6

Open
ciuncan opened this issue Jun 17, 2014 · 8 comments
Open

Add a language specification, guide and/or tutorial. #6

ciuncan opened this issue Jun 17, 2014 · 8 comments

Comments

@ciuncan
Copy link

ciuncan commented Jun 17, 2014

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.

@mdiebolt
Copy link
Contributor

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.

@ciuncan
Copy link
Author

ciuncan commented Jun 20, 2014

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.

@STRd6 STRd6 reopened this Jun 20, 2014
@metaperl
Copy link

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.

@STRd6
Copy link
Owner

STRd6 commented Jun 21, 2014

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
Copy link
Owner

STRd6 commented Jul 9, 2014

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

@voronianski
Copy link

+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.

@barbalex
Copy link

+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

@STRd6
Copy link
Owner

STRd6 commented Jul 3, 2019

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

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

6 participants