search

asciidoctor / jekyll-asciidoc-quickstart

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

GH-Pages site #2

Closed johncarl81 closed 9 years ago

johncarl81 commented 9 years ago

It would be a great example to have a fork of the master repository, with the edits prescribed by the instructions, to actually work.

jaredmorgs commented 9 years ago

I don't know what GitHub Level AsciiDoctor is operating under, but I thought the non-free accounts have a few extra GHPage accounts thrown in. It would be great to see a http://jekyll-asciidoc.github.io site out there showing MarkDown a thing or two ;)

johncarl81 commented 9 years ago

Right, from my understanding if we push to the gh-pages branch, Github automatically hosts the pages under the url in the format you mentioned.

johncarl81 commented 9 years ago

I guess the downside of this would be when users fork the repo they would automatically fork the gh-pages branch as well. Not sure we want the confusion of having a non-functional setup with a prepopulated static site.

jaredmorgs commented 9 years ago

Yeah, I see what you mean @johncarl81 .

Just spitballing here: I wonder if we could drop in a variable that could populate the username.github.io account name somehow upon forking, maybe using some details from the _config.yaml file? I don't know how fragile that would be though, or even if it is possible to interrogate that type of info using variables.

I know that Barry created an animated GIF that walks folks through about a 30 second clip of some of the first config tasks. I think with some good instructions (which seem to be of high quality right now anyhow) and maybe a few long GIFs, we could guide the user through pretty well.

jirutka commented 9 years ago

I wonder if we could drop in a variable that could populate the username.github.io account name somehow upon forking…

What problem are you trying to solve? The configuration files, nor setup instructions doesn’t contain account name at all. When you fork it, clone it to your computer and run bundle install && bundle exec rake deploy, it just works — builds static HTML and pushes it to your fork on GitHub (to branch gh-pages) — without any additional configuration.

When you don’t want to build sites yourself on your local machine and instead push AsciiDoc sources to the repo and let some service to build it for you, then you need to setup Travis (for now; this will not be necessary when GitHub whitelist the jekyll-asciidoc plugin). This is also prepared in this repo, except GitHub token, that is needed for Travis to push static HTML to the repo. This token is unique for each user, so we can’t prepare it in any way. It’s the only one parameter in the setup that must be set (or changed) after forking this repo.

johncarl81 commented 9 years ago

Ok, I'm convinced this is unnecessary and, at worst, maybe misleading