Skip to content

Commit

Permalink
fix: docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
hugomrdias committed Jul 14, 2020
1 parent 28574ec commit 4ae2e91
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
2 changes: 1 addition & 1 deletion next/content/systems/filecoin_files/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ chunking, encoding, graph representations, `Pieces`, storage abstractions, and m

## Status Overview

{{< dashboard-level name="Files & Data" open="true">}}
{{< dashboard-level open="true">}}
19 changes: 7 additions & 12 deletions next/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,9 @@ yarn serve
# open http://localhost:1313/ in the browser
```
# Shortcodes
### `Mermaid`
### `Mermaid`
Inline mermaid syntax rendering
```html
<!-- Relative path -->
{{< mermaid file="full-deals-on-chain.mmd" />}}

<!-- From hugo content folder -->
{{< mermaid file="/intro/full-deals-on-chain.mmd" />}}

<!-- Inline -->
{{< mermaid >}}
graph TD
A[Christmas] -->|Get money| B(Go shopping)
Expand All @@ -40,7 +34,7 @@ graph TD
```

### `svg`
This shortcode includes zoom and pad feature.
This shortcode includes zoom and pad features.
```html
<!-- Relative path -->
{{< svg src="pull-flow.mmd.svg" title="Data Transfer - Pull Flow" >}}
Expand All @@ -51,7 +45,8 @@ This shortcode includes zoom and pad feature.

### `hint`
```md
{{< hint [info|warning|danger] >}}
<!-- info|warning|danger -->
{{< hint info >}}
**Markdown content**
Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
Expand Down Expand Up @@ -96,7 +91,7 @@ Random plain text context ...
```
# Document header
The first heading should be # Head with the dashs like below and should refer to the overall title of the document. The left nav **only** start on the second level of headings.
The first heading should be # Head with `---` like below and should refer to the overall title of the document. The right nav **only** starts on the second level of headings.

```md
---
Expand All @@ -109,7 +104,7 @@ title: Storage Power Actor
## Header for a section in this document
Some text

### Sub header for the previous section
### Sub header for the a nested section

## Another top level header
```
Expand Down

0 comments on commit 4ae2e91

Please sign in to comment.