1
0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00

update test doc, document repositories.yml links usage

This commit is contained in:
Matthias Kretschmann 2018-11-20 15:49:41 +01:00
parent 7f896375f3
commit 691959fa87
Signed by: m
GPG Key ID: 606EEEF3C479A91F
2 changed files with 3 additions and 21 deletions

View File

@ -27,7 +27,7 @@
- [Repositories](#repositories) - [Repositories](#repositories)
- [Development](#development) - [Development](#development)
- [Using npm](#using-npm) - [Using npm](#using-npm)
- [Using Docker](#use-docker) - [Using Docker](#using-docker)
- [Linting & Formatting](#linting--formatting) - [Linting & Formatting](#linting--formatting)
- [Editor Setup: VS Code](#editor-setup-vs-code) - [Editor Setup: VS Code](#editor-setup-vs-code)
- [GitHub GraphQL API](#github-graphql-api) - [GitHub GraphQL API](#github-graphql-api)
@ -166,7 +166,7 @@ Additionally, you can attach multiple links to a repo. The GitHub link is automa
url: https://github.com/oceanprotocol/keeper-contracts/tree/develop/doc url: https://github.com/oceanprotocol/keeper-contracts/tree/develop/doc
``` ```
in [`/data/repositories.yml`](data/repositories.yml). in [`/data/repositories.yml`](data/repositories.yml). The links defined in this file will also be used to enhance the display of the repository component on all other pages.
## Development ## Development

View File

@ -5,24 +5,6 @@ description: On this site, Markdown is transformed to HTML through Remark follow
For more complete info, see [John Gruber's original spec](http://daringfireball.net/projects/markdown/) and the [Github-flavored Markdown info page](http://github.github.com/github-flavored-markdown/). For more complete info, see [John Gruber's original spec](http://daringfireball.net/projects/markdown/) and the [Github-flavored Markdown info page](http://github.github.com/github-flavored-markdown/).
## Table of Contents
- [Headers](#header)
- [Emphasis](#emphasis)
- [Lists](#lists)
- [Links](#links)
- [Images](#images)
- [Code and Syntax Highlighting](#code-and-syntax-highlighting)
- [Tables](#tables)
- [Blockquotes](#blockquotes)
- [Inline HTML](#inline-html)
- [Horizontal Rule](#horizontal-rule)
- [Line Breaks](#line-breaks)
- [Videos](#videos)
- [React Components in Markdown](#react-components-in-markdown)
- [Repository Component](#repository-component)
- [Embedding File Contents from GitHub](#embedding-file-contents-from-github)
## Headers ## Headers
```text ```text
@ -347,7 +329,7 @@ Or, in pure Markdown, but losing the image sizing and border:
[![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE) [![IMAGE ALT TEXT HERE](http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)
``` ```
### Repository Component ## GitHub Repository Component
In all Markdown docs you can use some select React Components. This magic is done with [gatsby-remark-component](https://www.gatsbyjs.org/packages/gatsby-remark-component/). In all Markdown docs you can use some select React Components. This magic is done with [gatsby-remark-component](https://www.gatsbyjs.org/packages/gatsby-remark-component/).