jeromegn / DocumentUp

Pretty documentation generator for Github projects with proper Readme.
http://documentup.com
884 stars 90 forks source link

Using gh-pages example, lost SEO #45

Closed overshard closed 9 years ago

overshard commented 12 years ago

Using the method suggested for gh-pages you really lose/don't get any SEO benefit. Search engines basically see it as a blank page. I'm instead generating the page and copying over the HTML, maybe this should be the suggested method?

jeromegn commented 12 years ago

It's not perfect indeed.

Crawlers do index it though: https://developers.google.com/search-appliance/documentation/68/admin_crawl/AdvancedTopics#documentwrite

overshard commented 12 years ago

I know on Pinry when I switched over to the documentup.min.js file on gh-pages it basically got dropped from Google search results entirely. When I copied and pasted over the DocumentUp code it showed back up... Maybe you are using doesn't work because for one you are using a separate JS file, not inline, and it's pulling a page and then writing. From what this is saying I don't think it will take into account you pulling a documentup page then writing it.

jeromegn commented 9 years ago

The gh-pages thing is all JS and search engines don't really index that quite well yet (3 years later). Ideally I'll add a feature like allowing CNAMEs (like Github) and that should work better.

However, I think Google is now indexing JS-generated pages properly.