Skip to content
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

Moving the documentation site to VuePress #38

Open
ishitatsuyuki opened this issue Aug 7, 2018 · 1 comment
Open

Moving the documentation site to VuePress #38

ishitatsuyuki opened this issue Aug 7, 2018 · 1 comment

Comments

@ishitatsuyuki
Copy link

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?
@imnotjames imnotjames transferred this issue from typeorm/typeorm Oct 1, 2020
@LuoRiWuSheng
Copy link

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants