|
@@ -1,33 +1,35 @@
|
|
-Section number
|
|
|
|
----------------
|
|
|
|
|
|
+Section Number
|
|
|
|
+--------------
|
|
|
|
|
|
-This plugin adds section number to the article's context, in the form of `X.X.X`. Sections are indicated by `<h1>-<h6>` in the parsed html format.
|
|
|
|
|
|
+This plugin adds section numbers to an article's context, in the form of `X.X.X`. Sections are indicated via Markdown headers, which appear as `<h1> – <h6>` in the generated HTML.
|
|
|
|
|
|
-# Setting
|
|
|
|
|
|
|
|
-By default, up to 3 levels of sections are numbered. You can customize this value by defining `SECTION_NUMBER_MAX` in your setting file:
|
|
|
|
|
|
+# Settings
|
|
|
|
|
|
-```
|
|
|
|
-SECTION_NUMBER_MAX = 5
|
|
|
|
-```
|
|
|
|
|
|
+By default, up to three section levels will be prefixed with numbers. You can customize this value by defining `SECTION_NUMBER_MAX` in your settings file:
|
|
|
|
|
|
-# caution
|
|
|
|
|
|
+ SECTION_NUMBER_MAX = 5
|
|
|
|
+
|
|
|
|
+
|
|
|
|
+# Caveat
|
|
|
|
+
|
|
|
|
+The first section in the article will be marked as the top section level. Namely, if `<h3>` is the first section encountered, the plugin assumes that no `<h1>` or `<h2>` sections will be present. Otherwise an exception may result.
|
|
|
|
|
|
-The first section in the article will be marked as the top section level. Namely, if `<h3>` is the first encountered section, no `<h1>` or `<h2>` is supposed to exist. Else, exception may be thrown out.
|
|
|
|
|
|
|
|
# Example
|
|
# Example
|
|
-the following markdown content:
|
|
|
|
-```
|
|
|
|
-# section
|
|
|
|
-blabla
|
|
|
|
-## subsection
|
|
|
|
-blabla
|
|
|
|
-## subsection
|
|
|
|
-blabla
|
|
|
|
-# section
|
|
|
|
-blabla
|
|
|
|
-```
|
|
|
|
-will be
|
|
|
|
|
|
+
|
|
|
|
+The following Markdown content...
|
|
|
|
+
|
|
|
|
+ # section
|
|
|
|
+ blabla
|
|
|
|
+ ## subsection
|
|
|
|
+ blabla
|
|
|
|
+ ## subsection
|
|
|
|
+ blabla
|
|
|
|
+ # section
|
|
|
|
+ blabla
|
|
|
|
+
|
|
|
|
+... will be rendered as:
|
|
|
|
|
|
>#1 section
|
|
>#1 section
|
|
>blabla
|
|
>blabla
|
|
@@ -36,4 +38,4 @@ will be
|
|
>##1.2 subsection
|
|
>##1.2 subsection
|
|
>blabla
|
|
>blabla
|
|
>#2 section
|
|
>#2 section
|
|
->blabla
|
|
|
|
|
|
+>blabla
|