Store .vuepress folder in another directory

Question

Is there a way to configure vuepress to look for the folder .vuepress somewhere else than default /docs?

Hello from 2019--the new VuePress documentation site annoyingly doesn't have any way to navigate to the page, but they explain the recommended directory structure here. — MLQ
– MLQ, Commented Sep 6, 2019 at 5:33

tony19 · Accepted Answer · 2020-06-07 02:04:18Z

0

UPDATE: VuePress 1.5.0 now only reads from docs/.vuepress, so the workaround below no longer works. However, another possible (less elegant) workaround is to symlink the docs/.vuepress to the desired location (tested on macOS Catalina).

For example, you could symlink it to <projectRoot>/.vuepress on macOS with:

mkdir .vuepress docs
cd docs
ln -s ../.vuepress

As of VuePress 0.12.0, there's no specific configuration to set the location of .vuepress/. VuePress always looks for .vuepress/ in the target directory (docs/) and the immediate parent directory. If not found, VuePress creates .vuepress/ in the parent directory of docs/.

If your objective is to prevent the creation of docs/.vuepress/ and you didn't mind .vuepress/ in the parent directory of docs/:

Create .vuepress/config.js in the parent directory of docs/.

Edit that file to contain the following config:

module.exports = {
  dest: 'foo' // desired path to VuePress output
}

Run vuepress build in the parent directory of docs/.

The result of the above config is to create a directory foo/ with the VuePress static site output:

$ vuepress build

WAIT  Extracting site metadata...
[2:20:45 AM] Compiling Client
[2:20:45 AM] Compiling Server
(node:47073) DeprecationWarning: Tapable.plugin is deprecated. Use new API on `.hooks` instead
[2:20:48 AM] Compiled Server in 3s
[2:20:50 AM] Compiled Client in 5s
WAIT  Rendering static HTML...

DONE  Success! Generated static files in foo.

edited Jun 7, 2020 at 2:04

answered Jul 14, 2018 at 6:38

tony19

140k23 gold badges281 silver badges354 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

akauppi Over a year ago

Unfortunately the parent level .vuepress does not seem to work any more. VuePress 1.5.0 demands the configuration to be in docs/.vuepress/config.js

tony19 Over a year ago

@akauppi Thanks for the update! A simple workaround would be to symlink .vuepress so that docs/.vuepress links to the desired location.

akauppi Over a year ago

I tried that, but then changed my mind. My intention is to keep my repo as approachable for visitors as possible, and symlinks often work against that.

akauppi · Accepted Answer · 2020-06-06 20:36:09Z

0

Don't think there is. In 2018, the author has stated:

I don't see practical value in this except for personal preference, so probably not.

answered Jun 6, 2020 at 20:36

akauppi

18.2k15 gold badges105 silver badges131 bronze badges

Collectives™ on Stack Overflow

Store .vuepress folder in another directory

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related