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

Automatically build and publish site to GitHub Pages using official GitHub Action workflow #36

Closed manoelcampos closed 1 year ago

manoelcampos commented 2 years ago

The repository enables one to quickly create a Jekyll website without requiring local tools. However, the project is not configured to automatically build and publish the site to GitHub Pages.

This PR enables a user to just fork the repo, set gh-pages as the output branch for GitHub Pages and he/she will have a live website without any hassle. You can check the live website for my repository at https://manoelcampos.github.io/jekyll-asciidoc-quickstart

Changes performed are:

Since this project is a template for users to create their own websites, the repository might be changed to template in the Settings tab. After changing that, a better description for the project might be "A Jekyll site template using Asciidoc: fork it and start writing posts for your own website".

Finally, if you set the gh-pages as the output branch in Settings >> Pages, users will have a live website to see results before even forking the repo. After configuring that, you might add https://asciidoctor.github.io/jekyll-asciidoc-quickstart to the repository website URL in ⚙️. This way, users can see how the resulting website looks like.

manoelcampos commented 1 year ago

Hey @mojavelinux I know you have lots of projects to take care, but I’d love to see this PR being reviewed and merged. Humbly, I think it’s a great contribution and I’m open to help anyway needed.

mojavelinux commented 1 year ago

As I said in the project chat, I'm no longer maintaining this repository or jekyll-asciidoc. We are actively seeking a new maintainer. If a maintainer does not come forward by the end of the year, we are going to archive this repository.

I like the ideas here in general. Despite not being the maintainer, I'd be willing to push this forward. However, I would like to request one change regarding:

Remove Gemfile.lock from .gitignore and adds it to the repository. That file is required to build the website.

In Asciidoctor, we don't consider it a good practice to commit this file. It makes the build non-portable because Bundler hard-codes the platform and Bundler version. It also makes it harder to maintainer as it constantly has to be updated.

If you revert that change, I'd be willing to take the time to merge it.

manoelcampos commented 1 year ago

I’ll revert that tomorrow and let you know. Thanks

manoelcampos commented 1 year ago

Hey @mojavelinux As requested, commit 67a2ae76e1b71e27696fd9fc261453cb2da43e88 reverts the inclusion on Gemfile.lock inside the repo. Please let me know if there is something else I can help.

I've never used Jekyll myself and I'm not a ruby developer. I contributed to this repo because I think it's a great option for creating asciidoc websites. I've created my own alternative to publish simple websites with http://github.com/manoelcampos/asciidoctor-ghpages-action/, before finding out jekyll-asciidoc-quickstart.

But I may try to help maintain this repo.

mojavelinux commented 1 year ago

Merged as 9db276af283bc320e7931727dc3a98d8ed205d5a

Thanks!

If you see anything else you'd like to see updated, please submit a separate PR.

manoelcampos commented 1 year ago

Great. Thanks. Just remember to change the repository to a template in the settings, so it's easier for users who just want to create a website from the template.

mojavelinux commented 1 year ago

Aha! That's right! Thanks for the reminder. That should be done now. If anything is still missing, don't hesitate to let me know.