codesnip
codesnip copied to clipboard
Create a GitHub Pages documentation site for CodeSnip
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?
Probably one for belvedere
?
Create as Markdown based site like ddablib/ddablib.github.io
?
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.
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.
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:
- Rename
Docs
asdocs
and exclude any existing files that should not be included in the website using Jekyll's_config.yml
. - Rename
Docs
asdocumentation
, leaving any files in there that should not be included in the website, and create a newdocs
directory for the website's files.