codesnip icon indicating copy to clipboard operation
codesnip copied to clipboard

Create a GitHub Pages documentation site for CodeSnip

Open delphidabbler opened this issue 1 year ago • 4 comments

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 avatar Sep 07 '22 10:09 delphidabbler

Probably one for belvedere?

delphidabbler avatar Sep 17 '22 20:09 delphidabbler

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

delphidabbler avatar Sep 17 '22 20:09 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 avatar Sep 18 '22 23:09 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 avatar Sep 18 '22 23:09 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 avatar Nov 09 '22 23:11 delphidabbler