typeorm.github.io icon indicating copy to clipboard operation
typeorm.github.io copied to clipboard

Moving the documentation site to VuePress

Open ishitatsuyuki opened this issue 7 years ago • 1 comments

Issue type: documentation issue

I'm proposing to migrate the documentation to use VuePress.

It has the following benefits:

  • Fully server-side rendered (better first load time)
  • Pre-compiled Vue components (smaller bundle size and better performance)
  • Compiles markdown during build (documentation fetched from GitHub pages instead of "Raw")
  • Additional features like search

Afterwards, documentation would be able to be directly built and served within this repo. You can host it with either GitHub pages or Netlify (the latter has more feature but needs a brief setup).

Before I file a PR, please answer the following questions:

  • Is this migration desirable?
  • Is the default theme (used on vuepress.org) desirable, or we should modify that to match our current styles?

ishitatsuyuki avatar Aug 07 '18 13:08 ishitatsuyuki

Issue type: documentation issue

I'm proposing to migrate the documentation to use VuePress.

It has the following benefits:

  • Fully server-side rendered (better first load time)
  • Pre-compiled Vue components (smaller bundle size and better performance)
  • Compiles markdown during build (documentation fetched from GitHub pages instead of "Raw")
  • Additional features like search

Afterwards, documentation would be able to be directly built and served within this repo. You can host it with either GitHub pages or Netlify (the latter has more feature but needs a brief setup).

Before I file a PR, please answer the following questions:

  • Is this migration desirable?
  • Is the default theme (used on vuepress.org) desirable, or we should modify that to match our current styles?

good idea!

LuoRiWuSheng avatar Apr 08 '23 06:04 LuoRiWuSheng