Skip to content

Commit

Permalink
Add section on referencing documents (#394)
Browse files Browse the repository at this point in the history
Closes #240
  • Loading branch information
JoelMarcey committed Jan 12, 2018
1 parent 00270c2 commit 1d967a9
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/guides-navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@ id: navigation
title: Navigation and Sidebars
---

## Referencing Site Documents

If you want to reference another document in your `docs` folder (or the location you set via the [optional `customDocsPath`](https://docusaurus.io/docs/en/site-config.html#optional-fields) path site configuration option), then you just use the name of the document you want to reference.

For example, if you are in `doc2.md` and you want to reference `doc1.md`:

```
I am referencing a [document](doc1.md).
```

> Docusaurus currently does not support documents in nested folders; only in a flatfile structure. We are looking into adding support for nested folders.
## How Documents are Linked

New markdown files within `docs` will show up as pages on the website. Links to those documents are created first by using the `id` in the header of each document. If there is no `id` field, then the name of the file will serve as the link name.
Expand Down

0 comments on commit 1d967a9

Please sign in to comment.