.html -> .md

[robrich]

On the website it's correctly linking to install.html. On GitHub's markdown rendering, it yields a 404.

[jsf-clabot]

All committers have signed the CLA.

[icambron]

Won't this break the website, though? In general, the markdown doesn't "work"; it only works when compiled. For example, the links into the API docs don't work either.

I tried to capture that here: https://github.com/moment/luxon/blob/master/docs/readme.md

I'd of course love to fix it so that it works in both places.

[robrich]

Good point. Google landed me to the github page rather than the docs site suggesting we may need to adjust SEO details.

And yes, making this change here will break the "compiled" versions. Perhaps the compilation step could rewrite .md to .html on the way through? How do I run the compilation locally to understand the feasability of this?

[robrich]

Also, the build fail is really interesting. If running from Dec 31 and adding 1 day, the relative date says "next year" not "tomorrow". Is this issue-worthy?

[icambron]

npm run docs. In theory you can do it with an esdoc plugin. Last time I tried to do that, I ran into trouble, but I don't recall why

[icambron]

The issue about "next year" is #394

[robrich]

Not finding the feature in esdoc docs, I asked esdoc/esdoc#558. If this doesn't yield a built-in feature, we could pre-regex the files before building, but that seems quite heavy-handed. (Their github repo is .html files: https://github.com/esdoc/esdoc-site/blob/master/docs/manual/config.html)

[icambron]

In my experience, you are unlikely to get a response from the esdoc maintainer.

[icambron]

I wonder if for 2.0, we should scrap esdoc and use typedoc or similar. Then the conversation about how to deploy the markdown gets reset anyway

[GillesDebunne]

I have not tried typedoc or other alternatives, but a typescript-aware doc would be nice.

…

On Wed, Jan 29, 2020 at 2:43 PM Isaac Cambron ***@***.***> wrote: I wonder if for 2.0, we should scrap esdoc and use typedoc or similar. Then the conversation about how to deploy the markdown gets reset anyway — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#637?email_source=notifications&email_token=AAOPFGTSLAI3RJIINYSBTPTRAGBXHA5CNFSM4KBWTVD2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOEKHHEVY#issuecomment-579760727>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAOPFGTEOQXXG43BAK3ML3DRAGBXHANCNFSM4KBWTVDQ> .

[icambron]

Going to close this one for now. Let's revisit when we do 2.0.