Closed svetlyak40wt closed 5 years ago
@svetlyak40wt Thanks for the PR.
Since the gh-pages plugin github has updated the funcionality of pages, so certainly makes sense to update the plugin to accomodate the new funcionality. When using a gh-pages branch the repo owner has to first make create an orphan [gh-branch] branch. Is that the case? If so we should update the plugin's documentation. (An ideally write a guide of how to post to gh-pages using Colesalw on the wiki).
@PuercoPop by the way, I'm wondering, why are you use wiki instead of gh-pages? It is very conceptual to generate documentation for Coleslaw with Coleslaw :)
@svetlyak40wt The wiki is used because the barrier for contribution is lower, everyone can edit it. Although I'm not fond of the wiki's xref capabilities.
Although using Coleslaw to build and publish its own documentation seems like a good idea at first, Coleslaw is blogware at heart so it is well suited to for documentation, which needsneeds xref-ing, an index and ToC with minimal effort. Then again Coleslaw is designed to be Flexible as well so I won't discourage you from trying. Probable writting the front page using static-pages
should be good enough for a ToC.
It may be worth the effort to see how can Coleslaw be leveraged to use CommonDoc's CLOS document representation to ease the process of writing documentation for CL proyects. Something more flexible than Codex.
I've had a "version 2 rewrite" on my mind for a while but work has kept me away from the endeavor and I would want there to be a reasonable upgrade path. Ultimately, Coleslaw (0.x) is flexible as blogware but not for static site building in general. "One of these days" :tm:
At that point, Coleslaw docs in coleslaw would be a great dogfooding test. :)
looking into this
Made a simple-gh-pages branch --- it simply uses a shell script and simply more compact.
Closing in favor of a simpler, shellscript-based approach, which, so far, requires a unix-like environment. Will create a new issue that address the windows support and the collaboration with other documentation generator.
Previously, gh-pages plugin only created a CNAME file inside a staging directory, but this version is able to update gh-pages branch of the current repository and to push this branch to the GitHub.
This way, publishing site becomes as simple, as: