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.

Sign up for GitHub

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

Use same directory listing format #558

Merged
merged 4 commits into from
Jun 9, 2018
Merged

Use same directory listing format #558

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c7de9f8
Use same directory listing format
eigan Jun 8, 2018
1b19669
Update root directory name, reviewed by @ulivz
eigan Jun 8, 2018
3eae928
chore: tweaks
ulivz Jun 9, 2018
9a3d484
chore: tweaks
ulivz Jun 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/guide/basic-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
Without any configuration, the page is pretty minimal, and the user has no way to navigate around the site. To customize your site, let's first create a `.vuepress` directory inside your docs directory. This is where all VuePress-specific files will be placed in. Your project structure is probably like this:

```
cwd
├─── docs
│ ├── README.md
│ └── .vuepress
│ └── config.js
└── package.json
.
├─ docs
│ ├─ README.md
│ └─ .vuepress
│ └─ config.js
└─ package.json
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dot here would have the different meaning with comparing to other parts. we should keep the cwd

```

The essential file for configuring a VuePress site is `.vuepress/config.js`, which should export a JavaScript object:
Expand Down
8 changes: 4 additions & 4 deletions docs/guide/i18n.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
To leverage multi-language support in VuePress, you first need to use the following file structure:

```
/
.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changing all the . to docs would be better.

├─ README.md
├─ foo.md
├─ /nested/
├─ nested
│  └─ README.md
└─ /zh/
└─ zh
├─ README.md
├─ foo.md
└─ /zh/nested/
└─ nested
   └─ README.md
```

Expand Down
12 changes: 6 additions & 6 deletions docs/zh/guide/basic-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
如果没有任何配置，这个网站将会是非常局限的，用户也无法在你的网站上自由导航。为了更好地自定义你的网站，让我们首先在你的文档目录下创建一个 `.vuepress` 目录，所有 VuePress 相关的文件都将会被放在这里。你的项目结构可能是这样：

```
cwd
├─── docs
│ ├── README.md
│ └── .vuepress
│ └── config.js
└── package.json
.
├─ docs
│ ├─ README.md
│ └─ .vuepress
│ └─ config.js
└─ package.json
```

一个 VuePress 网站必要的配置文件是 `.vuepress/config.js`，它应该导出一个 JavaScript 对象：
Expand Down
8 changes: 4 additions & 4 deletions docs/zh/guide/i18n.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
要启用 VuePress 的多语言支持，首先需要使用如下的文件结构：

```
/
.
├─ README.md
├─ foo.md
├─ /nested/
├─ nested
│  └─ README.md
└─ /zh/
└─ zh
├─ README.md
├─ foo.md
└─ /zh/nested/
└─ nested
   └─ README.md
```

Expand Down