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

Versioning #109

Open
fimbault opened this issue Oct 27, 2020 · 7 comments
Open

Versioning #109

fimbault opened this issue Oct 27, 2020 · 7 comments
Labels
enhancement New feature or request has-workaround Has workaround, low priority stale

Comments

@fimbault
Copy link

Is your feature request related to a problem? Please describe.
Related to documentation versioning

Describe the solution you'd like
A way to version a set of markdown documents

Describe alternatives you've considered
Similar to VuePress Plugin or Docusaurus2

@kiaking kiaking added the enhancement New feature or request label Nov 18, 2020
@brc-dd
Copy link
Member

brc-dd commented Jun 3, 2022

Well there is another workaround. Move your old docs to a subdomain. Then you can write config like this:

import { defineConfig } from 'vitepress'

export default defineConfig({
  themeConfig: {
    nav: [
      {
        text: 'v3 (stable)',
        items: [
          {
            text: 'v2 (legacy)',
            link: 'https://v2.vuejs.org/'
          }
        ]
      }
    ]
  }
})

It will be rendered like this:

image

@jcstein
Copy link

jcstein commented Aug 22, 2023

hi again @brc-dd - do you have recommended practices on moving old versions to subdomain? if you do, have you seen anyone do this on github pages? we're thinking of moving another docs site to vitepress, but this is the one remaining blocker

@github-actions github-actions bot added the stale label Sep 25, 2023
@DMiradakis
Copy link

+1 this would really be essential. I'm trying to think of how to build this in VitePress, but I'm not sure at the moment.

@github-actions github-actions bot removed the stale label Nov 6, 2023
@drwpow
Copy link

drwpow commented Nov 19, 2023

I’m pretty sure this is just done with multiple sidebars. Just move your versioned docs to a subfolder with the version in them.

You can then add a link to the nav where a user selects the version, and on change, the correct sidebar will show.

@IMB11
Copy link

IMB11 commented Dec 26, 2023

I've utilized multiple sidebars, a nav switcher etc. to create a versioning example that should suffice for most projects until proper versioning support is added.

You can view it here: https://github.com/IMB11/vitepress-versioning Now a plugin on NPM! https://www.npmjs.com/package/vitepress-versioning-plugin

Im unsure how to make it a library, or whether it's even worth being a library

@IMB11 IMB11 mentioned this issue Dec 27, 2023
@ciscoo
Copy link

ciscoo commented Jan 15, 2024

Well there is another workaround. Move your old docs to a subdomain. Then you can write config like this:

I would not consider this a workaround primarily because it assumes you have a domain. For users that use GitHub Pages without a custom domain, it is not possible.

A workaround, in my opinion, is something that can be done purely within the constraints of VitePress. The approaches that @drwpow and @IMB11 provided I would consider workarounds.

@IMB11
Copy link

IMB11 commented Jan 15, 2024

I actually ended up turned my example into a proper plugin/library: https://www.npmjs.com/package/vitepress-versioning-plugin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request has-workaround Has workaround, low priority stale
Projects
None yet
Development

No branches or pull requests

8 participants