Open feltnerm opened 10 years ago
:thumbsup: My limited experience with jekyll has been positive.
Sems docfu is working well enough for us. Any plans to overhaul it, @feltnerm?
@rnicholus -- I'd still love to overhaul it simply because I think it should be easier to develop against our documentation generator, and it should be easier to compile the docs.
Right now our documentation is generated via docfu. The main reason for doing this doc generator being written in Python rather than JS is the documentation server host does not have node.js installed on their system.
I'd like to convert the docs generator to node, make the api accessible via grunt, cli, or just
require
, and be able to use that for this project. This would keep the entire project in line with the fact that it is a javascript project. The generator would most likely use a bunch of pre-existing modules. My only issue is the availability of node on shared hosting.There are a few options I can think of:
Keep current workflow
Pros:
Cons:
Deploy the documentation somewhere
Convert documentation generator to Javascript. Use a javascript Jinja2 parser. Create the documentation locally -- or have on a server which listens to GitHub hooks -- and then send the compiled assets to a host.
Pros:
Cons:
Move the documentation to GitHub using Jinja2
Convert documentation generator to Javascript. Use a javascript Jinja2 parser. Create a new repo (fine-uploader-docs) which will serve as the content host for the documentation where everything is hosted in
gh-pages
. The build scripts are inmaster
. Could use existing node modules to do a lot of the heavy lifting.Pros:
Cons:
Move the documentation to GitHub using Jekyll
Convert the documentation and templates from Jinja2 syntax to Jekyll-compatible template syntax. Create a new repo (fine-uploader-docs) which will serve as the content host for the documentation. A more extreme option (most likely not possible due to sub-domains) is to move the docs to the main repository's
gh-pages
.Pros:
Cons: