Create Documentation

Problem/Motivation

This issue is being created to discuss documentation for the UIkit theme. Any questions or comments should be added here instead of creating a new issue. If any issues are created relating to documentation, they will be marked as a duplicate and referenced here.

In order to create useful documentation I will be adding updates with minimal instructions and verbiage. Hopefully this will encourage others to contribute more to the documentation. Anyone is welcome to contribute to the documentation by submitted patches in this issue.

Proposed resolution

The UIkit documentation is currently being regularly maintained and updated, along with theme development. The goal is to create documentation that is easy to follow yet informative. You can find the documentation in the uikit/uikit_core/docs directory of the theme.

An API site has been set up at uikit-drupal.com. uikit-drupal.com utilizes the API module to parse the docblocks in the UIkit docs folder. I've created several custom docblock tags to style elements with UIkit, so the API module used is a fork of the drupal.org API module. I also created a UIkit API installation profile to allow anyone to create their own UIkit API site for testing/patching purposes. Install the profile as you would any Drupal installation profile following these instructions. uikit-drupal.com uses the UIkit theme as a base theme, so it provides a demo of the UIkit theme.

I would discourage documenting anything the official UIkit Documentation already provides. No need to reinvent the wheel. There may be times we need to ignore this rule, but we should focus documenting the UIkit Drupal theme project (installing, theme settings, developer API, etc.).

Remaining tasks

#2798293: Initially hide advanced settings
#2788889: How are non-core js/css components loaded?

User interface changes

#2859466-4: Off-canvas menu not expanding
Use the UIkit Components module to enable navbar dropdown support mentioned in above issue.

API changes

#2854101-6: Support "Show as expanded" in uk-navbar
#2859925-2: Adding component assets