Skip to content

Commit

Permalink
docs: add page resources note to the readme (#1160)
Browse files Browse the repository at this point in the history
Co-authored-by: Yiannis Psaras <52073247+yiannisbot@users.noreply.github.com>
  • Loading branch information
hugomrdias and yiannisbot authored Sep 18, 2020
1 parent 4bb2138 commit e60e856
Showing 1 changed file with 24 additions and 20 deletions.
44 changes: 24 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,28 @@ This is the [Filecoin Specification](https://github.com/filecoin-project/specs),

## Table of Contents

- [Install](#install)
- [Writing the spec](#writing-the-spec)
- [Check your markdown](#check-your-markdown)
- [Page Template](#page-template)
- [Code](#code)
- [Images](#images)
- [Links](#links)
- [Shortcodes](#shortcodes)
- [`embed`](#embed)
- [`listing`](#listing)
- [`mermaid`](#mermaid)
- [`hint`](#hint)
- [Math mode](#math-mode)
- [Wrap `def`, `gdef`, etc.](#wrap-def-gdef-etc)
- [Wrap inline math text with code blocks](#wrap-inline-math-text-with-code-blocks)
- [Wrap math blocks with code fences](#wrap-math-blocks-with-code-fences)
- [Front-matter](#front-matter)
- [External modules](#external-modules)
- [Solving Common problems](#solving-common-problems)
- [References](#references)
- [Filecoin Specification](#filecoin-specification)
- [Table of Contents](#table-of-contents)
- [Install](#install)
- [Writing the spec](#writing-the-spec)
- [Check your markdown](#check-your-markdown)
- [Page Template](#page-template)
- [Code](#code)
- [Images](#images)
- [Links](#links)
- [Shortcodes](#shortcodes)
- [`embed`](#embed)
- [`listing`](#listing)
- [`mermaid`](#mermaid)
- [`hint`](#hint)
- [Math mode](#math-mode)
- [Wrap `def`, `gdef`, etc.](#wrap-def-gdef-etc)
- [Wrap inline math text with code blocks](#wrap-inline-math-text-with-code-blocks)
- [Wrap math blocks with code fences](#wrap-math-blocks-with-code-fences)
- [Front-matter](#front-matter)
- [External modules](#external-modules)
- [Solving Common problems](#solving-common-problems)
- [References](#references)

## Install

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

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

> 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.
## Check your markdown

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:
Expand Down

0 comments on commit e60e856

Please sign in to comment.