Docs website: convert to using Jekyll #141
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The initial homepage was set up in HTML as it (temporarily) had to be hosted elsewhere.
The intention was always to use GH Pages for hosting the site and to use Jekyll to generate the homepage content based on the
README
of the project.To allow for that to happen, some changes were needed which are contained in this PR.
Gemfile
pointing enabling the GH Pages gem, including enabling a new GH flavoured markdown interpreter._config.yml
file.repository
andgithub
keys to allow for local testing.minimal
theme.To allow the site to take full advantage of that, most copied in files from the theme can be removed as they will automatically be added now, as well as updated when needed.
.gitignore
file is put in place to ignore the typical Gem related files as well as the Jekyll output in_site
from being committed..nojekyll
file is put in place in thephpdoc
subdirectory to prevent Jekyll trying to parse the PHPDocumentor generated documentation.style.css
file tostyle.scss
.This makes it crystal clear what the customizations are and what comes from the theme.
The Jekyll build will combine the CSS into one
style.css
file for the generated site._default.html
layout has been copied in from the theme and minimal adjustments have been made to:robots.txt
file pointing to the plugin generated XML sitemap fo search engines.index.html
file with anindex.md
file which contains the same basic contents as theREADME.md
file.Includes making a few small adjustments to the
README.md
file.This should now allow for doing a plain copy & paste of the README content into the
docs/index.md
just before each release to update the homepage to the latest content.Note: there is a "readme to index" plugin available, but that does not allow for the readme and the docs being in different directories.
A feature request to allow for that has been opened.
Once this is merged, to update the website means:
README.md
file todocs/index.md
(and double-checking the few remaining differences are intact).develop
has been merged intomaster
, the website should be updated.The website can be viewed locally by running:
bundle update bundle exec jekyll serve
and then visiting http://localhost:4000/ to see the result.
Travis: add a build check for the GH Pages site
This should check on each PR and merge to
master
whether the GH pages site can be build without errors.