search

GSA / api-documentation-template

Other
10 stars 29 forks source link

Add HTML files #41

Open Ryandaydev opened 7 years ago

Ryandaydev commented 7 years ago

The current structure uses Jekyll/Markdown and HTML files are not exposed or shared. (GH pages generates those in the background.)

Consider including the HTML files in this repo in some fashion, so that projects who wanted to use the HTML on a separate host could use those without the markdown.

This could be done by including the _site files from the local build, which are currently in the .gitignore file. (Probably configure the Jekyll build to move them to a different folder.)

mvogelgesang commented 7 years ago

@rdgsa using the jekyll build --destination example command, we can create the example directory you speak of. To make sure this gets updated with each pull request, some clear release instructions may address the need. Long term, there is probably a way to script this via Travis or Circle CI.

mvogelgesang commented 7 years ago

Digging into this, it looks like #25 must be done first. Otherwise, the example directory is output in api-docs which is not desirable.