Skip to content

Commit 017f858

Browse files
committed
Update guidance on header structure in developer guide
1 parent 304f721 commit 017f858

File tree

1 file changed

+0
-56
lines changed

1 file changed

+0
-56
lines changed

doc/guide/Guide_CLIMADA_Tutorial.ipynb

Lines changed: 0 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -116,62 +116,6 @@
116116
"\n",
117117
"The title of the tutorial should be of level 1 (#), should have its own cell, and should be the first cell of the notebook."
118118
]
119-
},
120-
{
121-
"attachments": {},
122-
"cell_type": "markdown",
123-
"metadata": {},
124-
"source": [
125-
"## Table of content\n",
126-
"\n",
127-
"The second cell of the notebook should be the table of content and should have a header name *'Content'* and a level of 2 (##).\n",
128-
"\n",
129-
"To create the table of content, avoid using numbers to list the different sections, prefer instead simple dots by using '**-**' :\n",
130-
"\n",
131-
"\n",
132-
"-\n",
133-
"-\n",
134-
"\n",
135-
"\n",
136-
"Instead of numbers :\n",
137-
"\n",
138-
"1.\n",
139-
"2.\n",
140-
"\n",
141-
"\n",
142-
"Additionally, the table of content should only contain headers of level 2 (##).\n",
143-
"\n",
144-
"To create a link from the table of content to a certain section of the tutorial, write [Name of your choice] followed by (#Exactly-the-header-name-you-want-to-direct-the-user-to).\n",
145-
"\n",
146-
"Remember to fill white spaces with '-' and that links to headers are case sensitive! (#This-paRt-Is-CaSe-sEnSitIve).\n",
147-
"\n",
148-
"See the syntax of the example below to create a table of content. \n"
149-
]
150-
},
151-
{
152-
"attachments": {},
153-
"cell_type": "markdown",
154-
"metadata": {},
155-
"source": [
156-
"### Input:\n",
157-
"\n",
158-
"```markdown\n",
159-
"## Content\n",
160-
"\n",
161-
"- [My first header](#My-first-header)\n",
162-
"- [My second header](#My-second-header)\n",
163-
"- [My third header](#My-third-header)\n",
164-
"\n",
165-
"```\n",
166-
"\n",
167-
"### Output:\n",
168-
"\n",
169-
"## Content\n",
170-
"\n",
171-
"- [My first header](#My-first-header)\n",
172-
"- [My second header](#My-second-header)\n",
173-
"- [My third header](#My-third-header)"
174-
]
175119
}
176120
],
177121
"metadata": {

0 commit comments

Comments
 (0)