Commit a983cd6
committed
Docs website: convert to using Jekyll
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.
1. Add a `Gemfile` pointing enabling the GH Pages gem, including enabling a new GH flavoured markdown interpreter.
2. Add a `_config.yml` file.
- Enable the new GH flavoured markdown interpreter.
- Set the theme.
- Enable a variety of plugins.
- Add the `repository` and `github` keys to allow for local testing.
- Add a range of keys with information for the theme and SEO plugin.
- Explicitly exclude a number of files from being included in the generated site.
3. The initial homepage was already based on the GH Pages Jekyll `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.
4. A `.gitignore` file is put in place to ignore the typical Gem related files as well as the Jekyll output in `_site` from being committed.
5. A `.nojekyll` file is put in place in the `phpdoc` subdirectory to prevent Jekyll trying to parse the PHPDocumentor generated documentation.
6. The CSS customizations have been moved from the (theme generated) `style.css` file to `style.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.
7. The theme `_default.html` layout has been copied in from the theme and minimal adjustments have been made to:
- Overrule the syntax highlighting styles by setting a separate stylesheet for those.
- Add the "Read the docs" button in the left column.
- Add the "Install using Composer" section in the left column.
- Add the Twitter share button in the left column.
8. Add a `robots.txt` file pointing to the plugin generated XML sitemap fo search engines.
9. Replace the `index.html` file with an `index.md` file which contains the same basic contents as the `README.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](benbalter/jekyll-readme-index#19) to allow for that has been opened.
Once this is merged, to update the website means:
1. Running PHPDocumentor.
2. Copy & pasting the content from the `README.md` file to `docs/index.md` (and double-checking the few remaining differences are intact).
3. Once those changes have been merged and `develop` has been merged into `master`, the website should be updated.
The website can be viewed locally by running:
```bash
bundle update
bundle exec jekyll serve
```
and then visiting http://localhost:4000/ to see the result.1 parent ec02431 commit a983cd6
File tree
32 files changed
+408
-1897
lines changed- docs
- _layouts
- assets
- css
- fonts
- Noto-Sans-700italic
- Noto-Sans-700
- Noto-Sans-italic
- Noto-Sans-regular
- js
- phpdoc
32 files changed
+408
-1897
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | 36 | | |
37 | 37 | | |
| 38 | + | |
| 39 | + | |
38 | 40 | | |
39 | 41 | | |
40 | 42 | | |
| |||
71 | 73 | | |
72 | 74 | | |
73 | 75 | | |
| 76 | + | |
74 | 77 | | |
75 | 78 | | |
76 | 79 | | |
| |||
216 | 219 | | |
217 | 220 | | |
218 | 221 | | |
| 222 | + | |
| 223 | + | |
219 | 224 | | |
220 | 225 | | |
221 | 226 | | |
| |||
232 | 237 | | |
233 | 238 | | |
234 | 239 | | |
| 240 | + | |
235 | 241 | | |
236 | 242 | | |
237 | 243 | | |
| |||
241 | 247 | | |
242 | 248 | | |
243 | 249 | | |
244 | | - | |
| 250 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
0 commit comments