从 Vuepress 中排除 readme.md

Posted

技术标签:

【中文标题】从 Vuepress 中排除 readme.md【英文标题】:Exclude readme.md from Vuepress 【发布时间】:2019-01-17 09:58:31 【问题描述】:

我正在尝试从 Vuepress 中排除 README.md,以便将其用于 Github 文档。我使用index.md 作为我的主页。

有没有办法做到这一点?

我尝试过这样的事情,但这完全是盲目的,因为我不知道装载机叫什么:

chainWebpack: config => 
   config.module
      .rule('md')
      .exclude
      .add('README')

【问题讨论】:

可以添加完整的配置吗? 【参考方案1】:

您可以像这样构建您的存储库,有效地将 VuePress 应用程序下移一级(在本例中,在“站点”目录内):

├── site
│   ├── .vuepress
│   │   ├── components
│   │   ├── theme
│   │   ├── public
│   │   ├── styles
│   │   ├── config.js
│   ├── docs
│   │   ├── subDocs (Note: Nested docs)
│   │   └── README.md
│   ├── README.md (Note: The home page of the docs)
│   └── package.json
└── README.md (Note: GitHub documentation)

【讨论】:

以上是关于从 Vuepress 中排除 readme.md的主要内容,如果未能解决你的问题,请参考以下文章

如何像 VuePress 一样渲染 Markdown?

从0-;1实践-VuePress搭建组件库+文档

如何为 Vuepress 的特定页面使用自定义布局?

如何在 Vuepress 站点中使用 vue-apollo?

Vuepress 应用程序之外的相同域链接

使用VuePress创建Github Pages