Skip to content

Commit 1ea8c1b

Browse files
committed
Add TOC + more links
1 parent ba05180 commit 1ea8c1b

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ Hello world!
44

55
This is a test for delivering a README in the ReST format.
66

7+
------------------------------------------------------------------------------
8+
Table of contents
9+
------------------------------------------------------------------------------
10+
11+
.. contents::
12+
713
.. _section1:
814

915
------------------------------------------------------------------------------
@@ -22,7 +28,11 @@ Let's try some code:
2228
Subsection 1.1
2329
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2430

25-
Let's try a link to :ref:`section <section1>` 1 above.
31+
Let's try making links:
2632

27-
To be continued...
33+
* a local link with regular syntax to :ref:`section 1 <section1>` above
34+
* a local link with global syntax to `section 1 <section1>`_ above
35+
* an absolute link to `GitHub home page <https://github.com>`_
36+
* plain text automatically converted to an absolute link https://github.com
2837

38+
To be continued...

0 commit comments

Comments
 (0)