Set up jekyll-apple-help build pipeline

TzviPM commented 5 years ago

Summary

Generate pages for help book from markdown and JSON content using https://github.com/chuckhoupt/jekyll-apple-help. This will make it easier for newcomers to contribute help content to the project with confidence.

High-level overview

The XCode project now has a folder called XiEditorHelp, which contains the following structure:

This folder gets compiled as part of the XiEditorHelp build target, which generates a .help bundle:

The main files we'll want to edit for creating content are in the _English.lproj folder nested under XiEditorHelp. This folder contains numerous .md files with yml-formatted front matter.

Front matter should contain a title attribute as well as a description, and optionally an order to establish a consistent ordering of help topics.

An additional group property can specify a title for a folder in which to group topics together, aggregated by this given title.

the help bundle will be automatically rebuilt as part of the application build step.

Supersedes https://github.com/xi-editor/xi-mac/pull/400 Part of #252

Checklist

Example:

[x] Set up jekyll-apple-help
[x] Create content in md format
[x] Keyboard shortcuts stuff

Review Checklist

[x] I have responded to reviews and made changes where appropriate.
[x] I have tested the code
[x] I have updated comments / documentation related to the changes I made.
[x] I have rebased my PR branch onto xi-mac/master.

cmyr commented 5 years ago

@tzvipm Cool! Could you provide a bit of an overview of how this is intended to work, when it should be run, etcetera? Just a high level walk through, so I have a better sense of what to look for in review.

TzviPM commented 5 years ago

@cmyr I updated the description just now; is this kinda what you were looking for in a high-level overview?

jansol commented 5 years ago

Comments in the copied files linking to the source would be more useful IMHO...

nangtrongvuon commented 5 years ago

+1 to @jansol's comment, perhaps it's better to have the comments in the copied files (or just omit them entirely). It's kind of making the PR a bit cluttered and hard to read.

jansol commented 5 years ago

@tzvipm bump. Would be nice to get this out of the way...

xi-editor / xi-mac