Skip to content

Commit e60e856

Browse files
docs: add page resources note to the readme (#1160)
Co-authored-by: Yiannis Psaras <[email protected]>
1 parent 4bb2138 commit e60e856

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

README.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,26 +8,28 @@ This is the [Filecoin Specification](https://github.com/filecoin-project/specs),
88

99
## Table of Contents
1010

11-
- [Install](#install)
12-
- [Writing the spec](#writing-the-spec)
13-
- [Check your markdown](#check-your-markdown)
14-
- [Page Template](#page-template)
15-
- [Code](#code)
16-
- [Images](#images)
17-
- [Links](#links)
18-
- [Shortcodes](#shortcodes)
19-
- [`embed`](#embed)
20-
- [`listing`](#listing)
21-
- [`mermaid`](#mermaid)
22-
- [`hint`](#hint)
23-
- [Math mode](#math-mode)
24-
- [Wrap `def`, `gdef`, etc.](#wrap-def-gdef-etc)
25-
- [Wrap inline math text with code blocks](#wrap-inline-math-text-with-code-blocks)
26-
- [Wrap math blocks with code fences](#wrap-math-blocks-with-code-fences)
27-
- [Front-matter](#front-matter)
28-
- [External modules](#external-modules)
29-
- [Solving Common problems](#solving-common-problems)
30-
- [References](#references)
11+
- [Filecoin Specification](#filecoin-specification)
12+
- [Table of Contents](#table-of-contents)
13+
- [Install](#install)
14+
- [Writing the spec](#writing-the-spec)
15+
- [Check your markdown](#check-your-markdown)
16+
- [Page Template](#page-template)
17+
- [Code](#code)
18+
- [Images](#images)
19+
- [Links](#links)
20+
- [Shortcodes](#shortcodes)
21+
- [`embed`](#embed)
22+
- [`listing`](#listing)
23+
- [`mermaid`](#mermaid)
24+
- [`hint`](#hint)
25+
- [Math mode](#math-mode)
26+
- [Wrap `def`, `gdef`, etc.](#wrap-def-gdef-etc)
27+
- [Wrap inline math text with code blocks](#wrap-inline-math-text-with-code-blocks)
28+
- [Wrap math blocks with code fences](#wrap-math-blocks-with-code-fences)
29+
- [Front-matter](#front-matter)
30+
- [External modules](#external-modules)
31+
- [Solving Common problems](#solving-common-problems)
32+
- [References](#references)
3133

3234
## Install
3335

@@ -68,6 +70,8 @@ You can split out sub-sections by adding additional pages to a section directory
6870

6971
The markdown documents should all be well formed, with a single h1, and headings should increment by a single level.
7072

73+
> Note: Regular markdown files like `content/intro/concepts.md` can't reference resources such as images, or other files. Such resources can be referenced only from `_index.md` files. Given that a folder will have an `_index.md` file already, there is the following work around to reference resources from any file: create a new sub-folder in the same folder where the initial .md file was, e.g., `content/intro/concepts/_index.md`, include the content from `concepts.md` in the `_index.md` file, add the resource files (for example, images) in the new folder and reference the resource file from the new `_index.md` file inside the `concepts` folder. The referencing syntax and everything else works the same way.
74+
7175
## Check your markdown
7276

7377
Use `npm test` to run a markdown linter set up to check for common errors. It runs in CI and you can run it locally with:

0 commit comments

Comments
 (0)