entu / ssg

Simple Pug (Jade), Markdown, Yaml, Stylus static site generator
https://entu.site
MIT License
14 stars 4 forks source link

wrong (outdated?) installation docs #5

Open glensc opened 5 years ago

glensc commented 5 years ago

Your current installation docs say:

But the download link contains some huge 50MiB .zip, which looks like some bundled electron app, which by running does nothing but brings up some file open dialog, but i don't even have any file to open, or what kind of file, pressing cancel the app quits. no gain.

However the build.js seems to be in the repo itself, so the instructions should be perhaps git clone && npm install, or maybe even npm install -g if the project has been uploaded to npm.


Brief: I came to this project when i searched for static site generator, that can take yaml as extra data source. And this was included in https://www.staticgen.com/entu-ssg

argoroots commented 5 years ago

Thanks for pointing to error in docs. Quick explanation how to use it (will put it in docs also):

Files under latest builds are Windows/macOS GUI apps. On run, it will look for config file. After opening config file Entu SSG will generate HTMLs and run local webserver to see results.

For CLI you must install it via NPM: npm install entu-ssg To build Your site run node ./node_modules/entu-ssg/build.js entu-ssg.yaml, where entu-ssg.yaml is path to config file.

Here is one open source project what uses Entu SSG: https://github.com/citizenos/citizenos-web. You can see how it's done.