-
-
Notifications
You must be signed in to change notification settings - Fork 141
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Static HTML docs generator #652
base: master
Are you sure you want to change the base?
Conversation
Thank you for this PR! Really great stuff 🎉
Also links to GitHub are nice but I like having the source code inlined so maybe it can be a flag the defaults to inline and can be set if the author like it better. |
Thanks for guidance, I tried to incorporate the feedback into the latest updates
Notes: Configuring I know you said you prefer "view source" being embedded into the docs rather than linking to GH, but if you are okay with that as a followup I think this is probably ready for initial CR. |
Great, thanks for the fixes. Admittedly I never actually tried loading the files directly in the browser, I only ran it through a webserver. The |
This PR upgrades the
mint docs generate
command with static HTML generation.I tried to model the generators after the existing json generators. At first I couldn't decide if I should just split the html and json generation up into two separate commands and file structures but I think keeping them together like this makes a bit more sense and is cleaner.
At the moment, the css is being pulled from
mint-lang.com
, with some overrides and some net new css. I did this just to get started easier. We need to consolidate and move this css somewhere. My thought was putting it into theassets
folder so it is baked, and then generating a standalone css file that lives alongside and is referenced by the html files. I would like some direction on the css situation before continuing.Other notes
--git-url
,--git-url-pattern
should be settings inmint.json
, but I think the desire is to keep the mint.json as lean as possible--git-url
and--git-url-pattern
flags anyway, since theGitSource
class handles finding this information from the local repository. However, this class may be unnecessary complexity and we should just always require the flags to be passed if you want links properly generated.mint.json
perhaps? We also talked about adding ansource-examples
key or something like that, maybe it could interface with that?mint-lang.com/guide
made sense.