memos.pub icon indicating copy to clipboard operation
memos.pub copied to clipboard

docs(blog): Add custom domain guide

Open tuhuynh27 opened this issue 2 years ago • 1 comments

Memos.pub instantly makes a blog out of any public GitHub repo, with beautiful typography, MDX support, custom domain, and more.

Is there any guide to setting up a custom domain for now? I think it can be just simple as in Netlify, just point your domain CNAME record to some-blog.memos.pub.

Also, the 404 error happened on the org link:

https://keva-dev.memos.pub/blog

image

Not sure if this is a bug or an expected behavior

tuhuynh27 avatar May 06 '22 08:05 tuhuynh27

Is there any guide to setting up a custom domain for now?

Not yet but this is of highest priority. I'm working on such guide. That said, the functionality itself should work fine

I think it can be just simple as in Netlify, just point your domain CNAME record to some-blog.memos.pub.

It is :D you just need to set your CNAME of "blog" to "cname.vercel-dns.com"

To be clear, that's the only step you need, but on our side we need other steps as well (all are done on our side, don't worry, just list them here in case you are curious):

  • Link the domain to Vercel's memos.pub project (with the CNAME, we only link the domain to Vercel)
  • Link the github project to the domain: https://github.com/thien-do/memos.pub/commit/70548bc14beef00e1831f45ce1f15fcff0a5911d

And that's all. Thank you for trying this!

Also, the 404 error happened on the org link:

This won't be there in case of custom domain. However in case of using memos.pub subdomain, it is expected as it follows GitHub's behavior, which resolves to a same name repository if you don't provide a repository, that is when you are at root, your username. For example:

  • https://thien-do.memos.pub is resolved to https://github.com/thien-do/thien-do
  • Similary, https://keva-dev.memos.pub is resolved to https://github.com/keva-dev/keva-dev, which doesn't exist yet

That being said this needs another guide too. Thank for highlighting this!

thien-do avatar May 07 '22 06:05 thien-do