Create a GitHub Pages documentation site for CodeSnip

[delphidabbler]

Create a new website in the docs folder (repurposed) that can be published on delphidabbler.com.

Create this using the HTML Help file source.

In later versions consider removing the HTML help file and changing the CodeSnip help system to access the new site.

Possibly create a codesnip-docs sub-domain for this?

[delphidabbler]

Probably one for belvedere?

[delphidabbler]

Create as Markdown based site like ddablib/ddablib.github.io?

[delphidabbler]

If implementing for CodeSnip 4.x as a Markdown driven site will need some automated means of converting Html to Markdown to speed the process.

[delphidabbler]

If implementing for CodeSnip 4.x as a Markdown driven site will need some automated means of converting Html to Markdown to speed the process.

Best converter I've seen so far is https://www.convertsimple.com/convert-html-to-markdown/. Unlike some others, this converter handles table conversion.

[delphidabbler]

To add a documentation site that uses GitHub Pages will require a docs directory.

Since there is already a Docs directory this will cause a problem when checking out on Windows, since both directories are considered the same.

There are two options for getting round this problem:

1. Rename Docs as docs and exclude any existing files that should not be included in the website using Jekyll's _config.yml.
2. Rename Docs as documentation, leaving any files in there that should not be included in the website, and create a new docs directory for the website's files.

[delphidabbler]

This is quite a major undertaking that, in addition to converting the current HTML4 help files to Markdown will require CodeSnip's help engine to be overhaulEd.

Because CodeSnip has a well developed and functional help system, there is no urgency.

Therefore this issue is being deferred for possible inclusion in v5 or later.

[delphidabbler]

Since the last attempt to create CodeSnip 5 failed, and any subsequent version 5 will depend on the success of CodeSnip Cupola LE, this issue is being rejected and closed.

CodeSnip 4 will continue to use HTML help.

⭐ However, it is likely that CodeSnip Cupola LE will most likely have an online help system.