search

retrogradeorbit / bootleg

Simple template processing command line tool to help build static websites
Eclipse Public License 2.0
256 stars 12 forks source link

Quickstart example should walk you through one of the examples #6

Closed chr15m closed 5 years ago

chr15m commented 5 years ago

A beginner coming to this for the first time and seeing the "quickstart" examples with -e will probably get confused. What I want to see as a new user is basically the contents of examples/quickstart and the clojure code that would be required to render that into a site. I'd want this in a conversational tone like:

Quickstart

Imagine you have an HTML template like this:

<bod>...some valid code here...</body>

You want to merge that with a JSON file like this:

...

Then you want to include some Markdown from a file called README.md which looks like this:

...

And so on.

retrogradeorbit commented 5 years ago

I think this should not be quickstart. I was going to include a section further down called "Examples" with lots of more indepth examples.

Quickstart is for copy-paste... yes I get the same result... I will read further imho.

retrogradeorbit commented 5 years ago

Rewrote the quickstart to use files instead of -e evaluations. Reads much better now.

chr15m commented 5 years ago

Agree, LGTM!