Improve documentation by integrating VuePress

[kasvith]

Often when using Knex.js documentation I find it rather difficult to search for something. Also, the font size is too small. If we moved to a system like VuePress we get a lot of things out of the box

• Search(default or Algolia)
• Rendering support with themes(dark mode included)
• Ability to run JS(for example we can run Knex snippets as we already doing)
• Documentation with Markdown
• And ton more

Objection.js is already using VuePress and I find it very easy to navigate and use.

By doing this I hope Knex documentation will be much accessible and pleasant to work with.

[kasvith]

I can personally take a look at this

[kibertoad]

@kasvith That would be amazing!

[kasvith]

@kibertoad are there any special things to tackle down transition? I checked source code and it seems a combination with React and Webpack.

I would love to work with this in my free time

[kibertoad]

Personally I'm a big fan of Vue.js, so definitely would be happy to switch over from React. I think most of the documentation is rather straightforward, the most dynamic one is probably this: https://github.com/knex/documentation/blob/gh-pages/components/Changelog.jsx

[kasvith]

Yes I also noticed that.

Since VuePress can create a separate page for changelog i dont see why we cant include full version there. LMK what you think :)

[kasvith]

Also, we can switch over to Netlify from GitHub. It's Faster and even allows us to have [https://staging.knexjs.org]() based on branches.

I feel it's a lot flexible and more suitable for the task. I will also add Netlify build commands so if you like we can switch over easily

[kibertoad]

@kasvith Either version works for me. And after we switch to Vuepress, sure, I would be open to consider Netlify.

[kasvith]

Cool, I was considering about the current hyperlinks as well. We will also need a way to make them work as its been used by many people for references

[vencho-mdp]

Hi! Is anyone working on this feature?

[kasvith]

@vencho-mdp i didnt have time to work on this, if you start let me know

[vencho-mdp]

Hi! I could do this along the week. Anyways, I just wanted to make sure that it would be useful. Could you confirm this? @kibertoad

[kibertoad]

@vencho-mdp It definitely would be!

[vencho-mdp]

Sounds Great! This'll be the repo: https://github.com/vencho-mdp/knexjs-docs-vuepress, I'll tell you when I finish it.

[vencho-mdp]

Hi @kibertoad ! Could you sign up for Algolia on this link https://docsearch.algolia.com/? If you do it, I'll we able to integrate Algolia Search :)