[FOLIO-789] Investigate classic-jekyll-theme for use on dev.f.o Created: 21/Aug/17  Updated: 11/Jan/19  Resolved: 11/Jan/19

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: devweb
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Attachments: Zip Archive screenshots-20170821.zip    
Issue links:
Relates
relates to FOLIO-829 Implement classic-jekyll-theme for de... Closed
relates to FOLIO-644 Investigate suitable Jekyll themes an... Closed
Sprint:

 Description   

Assess the Balancingrock/classic-jekyll-theme



 Comments   
Comment by David Crossley [ 21/Aug/17 ]

In branch FOLIO-789-theme-cjt. Need to use the local Jekyll.

Comment by David Crossley [ 21/Aug/17 ]

The page /demo-theme-cjt/ leads to additional demonstration of some features.

The theme is very configurable. Only done the basics so far.

There are three columns available. This demo has them switched off for all pages, and on for some specific pages.

The navigation menus are easily configured using the YAML front-matter in each document. It was easy to build upon that to add other specific menu-items using a configuration file in "_data". Uses CSS only.

It was easy to apply an additional navigation bar to address the need for a top FOLIO-wide navigation bar ( FOLIO-714 Closed ).

The navigation menus are well-presented for medium and small browser width.

There is ability for a cookie warning. We don't yet use any, so configured off.

The source-code repository team is active and responsive.

Comment by David Crossley [ 23/Aug/17 ]

This is a good incremental step.

After a few days for any comments or other solutions, i will apply this theme. We can always change in the future if needed.

Comment by David Crossley [ 11/Sep/17 ]

Moving on to implement this theme. See FOLIO-829 Closed .

Its versatility enables us to automatically populate the content of the navigation menus. There can be other columns with global and section-specific content. It provides a foundation for various navigation-related improvements.

Leaving this issue and branch for further exploration.

Comment by David Crossley [ 15/Sep/17 ]

The recent version 1.9.3 has a new ability "menuSubs" to handle fragment identifiers in navigation menu items. So our local "nav-other" ability can be removed. See branch FOLIO-829-new-theme-cjt

Comment by David Crossley [ 18/Dec/17 ]

The dev branch of classic-jekyll-theme (upcoming v2) is making good progress toward even more configurability (e.g. see the many available tweaks in our "_sass" directory and _data/setup.yml).

One feature is to configure either the top menu bar to have dropdown menus, or to use the left-side panel for vertical menus. (See our "_data/setup.yml")

See the demonstrations:

The current master with the dropdown menus: dev.folio.org

A branch using the vertical left-hand side menus: FOLIO-789-theme-cjt-v2-side

Note that either way we could to do more configuration of the content of those menus. Not yet doing much with that until we settle on the re-arrangement of all docs FOLIO-645 Closed .

Comment by David Crossley [ 03/Jan/18 ]

The abovementioned demos now use the release 2.0.0

Another demonstration using the drop-down menus and Tocbot for in-page table-of-contents is at FOLIO-978 Closed

Comment by David Crossley [ 16/Jan/18 ]

The demonstration at FOLIO-978 Closed using Tocbot, now has improved presentation. It also uses the classic-jekyll-theme fixed top banner and left-hand vertical menus.

Comment by Peter Murray [ 16/Jan/18 ]

Hey David. I took a look at your work at http://folio-978-investigate-tocbot.dev.folio.org.s3-website-us-east-1.amazonaws.com/doc/ – thanks for setting this up! Are there two Table of Contents generators running on the system? I can't figure out the relationship between the one at the top (with the purple header) and the one at the bottom (with the orange theme).

Comment by David Crossley [ 17/Jan/18 ]

Ah, that confusion arose because i had not tidied up the old configuration of the general navigation menus. Removed that duplication now.

See the comment (four comments above this) regarding not doing much of that until FOLIO-645 Closed re-arrangement of all documentation.

See the new temporary "Tutorials" section, which is a better demonstration of the overall menu system and the in-page ToC.

Comment by David Crossley [ 11/Jan/19 ]

Done. This theme is implemented. See FOLIO-829 Closed .

Generated at Thu Feb 08 23:08:20 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.