Skip to content
This repository has been archived by the owner on Aug 7, 2020. It is now read-only.

Commit

Permalink
Minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell committed Mar 11, 2020
1 parent 7b97ce1 commit 6237141
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 11 deletions.
15 changes: 8 additions & 7 deletions docs/api/core_block_tokens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,30 +28,31 @@ These block tokens are defined in the
======

* - Paragraph
- General inline text
- General block of text
- .. code-block:: md

any *text*

* - Quote
- quoted text
- quoted block of text
- .. code-block:: md

> this is a quote

* - BlockCode
- indented text (4 spaces or a tab)
- .. code-block:: md
:name: blockcode

included as literal *text*
included as literal

* - CodeFence
- enclosed in 3 or more backticks with an optional language name
- .. code-block:: md

.. code-block:: python
print('this is python')
```python
print('this is python')
```

* - ThematicBreak
- Creates a horizontal line in the output
Expand All @@ -64,7 +65,7 @@ These block tokens are defined in the
- .. code-block:: md

- item
- nested item
- nested item
1. numbered item

* - LinkDefinition
Expand Down
10 changes: 6 additions & 4 deletions docs/api/core_span_tokens.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ These span tokens are defined in the
- Description
- Example
* - RawText
- any text
- any inline text
- .. code-block:: md

any text
Expand Down Expand Up @@ -53,13 +53,15 @@ These span tokens are defined in the
- link that is shown in final output
- .. code-block:: md

<http://www.google.com>
<https://www.google.com>

* - Link
- Reference ``LinkDefinitions``
- Reference a target or :py:class:`~mistletoe.block_tokens.LinkDefinition`
- .. code-block:: md

[text](target "title") or [text][key]
[text](target "title") or
[text][key] or
[key]

* - Image
- link to an image
Expand Down

0 comments on commit 6237141

Please sign in to comment.