search

asciidoctor / jekyll-asciidoc-quickstart

A template project for creating AsciiDoc-based websites using Jekyll.
https://asciidoctor.github.io/jekyll-asciidoc-quickstart/
MIT License
119 stars 159 forks source link

Provide screenshots of the expected output #19

Closed sboekhoff closed 1 year ago

sboekhoff commented 7 years ago

I'm setting up a workflow for GitLab-CI using the Jekyll-theme you provide.

In order to check if everything went right, it would be nice to have screenshots showing the expected output (e.g. in the README).

Here are screenshots (made with FireFox 48.0.2) of the output my workflow produced. Please let me know if this is the expected layout.

jekyll asciidoc quickstart jekyll asciidoc quickstart_smaller jekyll asciidoc quickstart_smallest

manoelcampos commented 1 year ago

After #36, there is a live website you can check the final results at https://asciidoctor.github.io/jekyll-asciidoc-quickstart. This way, screenshots aren't needed anymore.

mojavelinux commented 1 year ago

I agree that screenshots are unnecessary when you can see a live preview. Plus, screenshots require more effort to maintain. I think we could add an explanation to the README that calls attention to the live preview with a link to it. wdyt?

manoelcampos commented 1 year ago

I think adding a link to the live website is the best way to approach this issue. Maybe a note at the end of the first paragraph or even a subsection:

TIP: You can check a live website created from this repository at https://asciidoctor.github.io/jekyll-asciidoc-quickstart
mojavelinux commented 1 year ago

Go for it!