GithubHelp home page GithubHelp logo

Comments (1)

LuoRiWuSheng avatar LuoRiWuSheng commented on May 16, 2024

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!

from typeorm.github.io.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.