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

Document how readme is the index for a directory #368

Closed
cfjedimaster opened this issue May 8, 2018 · 2 comments
Closed

Document how readme is the index for a directory #368

cfjedimaster opened this issue May 8, 2018 · 2 comments

Comments

@cfjedimaster
Copy link

I'm going through the docs and while it is implied, it doesn't seem to be spelled out that the readme.md file is considered the 'index' for the site/folder. I first noticed this on the links doc (https://vuepress.vuejs.org/guide/markdown.html#links) where it shows a link to /foo/ and it's says:

<!-- Sends the user to index.html of directory foo -->

But in the file list above it, there is no index.html. I guess that would be another bug then (to go along with the general request in this issue :).

@lbenie
Copy link
Contributor

lbenie commented May 8, 2018

It's well explained in the doc here.

Each sub-directory in your static site should contain a README.md. It will automatically be converted to index.html.

@cfjedimaster
Copy link
Author

Dang that is super obvious - sorry!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants