Auto generate docs

Author: kdheepak

doc/panvimdoc.txt

@@ -20,10 +20,10 @@ that goal. This way, plugin authors will have to write documentation just once
 as part of the README of the project, and have the vim documentation
 autogenerated.
 
-Writing vim documentation requires conforming to a few simple rules. Although >
-vimdoc < is not a well defined spec, it does have some nice syntax highlighting
-and features like tags and links when a text file is in > vimdoc < compatible
-format and when the > filetype=help < in vim. Also, typically, while vim
+Writing vim documentation requires conforming to a few simple rules. Although
+>vimdoc< is not a well defined spec, it does have some nice syntax highlighting
+and features like tags and links when a text file is in >vimdoc< compatible
+format and when the >filetype=help< in vim. Also, typically, while vim
 documentation is just plain text files, they are usually formatted well using
 whitespace. Preserving these features and characteristics is important.
 
@@ -96,18 +96,10 @@ comment on this issue: |https://github.com/kdheepak/panvimdoc/issues/1|.
 The following are the metadata fields that the custom writer uses:
 
 
-->
-project
-< (String) _required_: This is typically the plugin name. This is prefixed to all generated tags
-->
-vimdoctitle
-< (String) _required_: This is the name of the documentation file that you want to generate
-->
-vimversion
-< (String) _optional_: The version vim / neovim that the plugin is targeting. If not present, the version of vim in the available environment is used.
-->
-toc
-< (Boolean) _optional_: Whether to generate table of contents or not
+->project< (String) _required_: This is typically the plugin name. This is prefixed to all generated tags
+->vimdoctitle< (String) _required_: This is the name of the documentation file that you want to generate
+->vimversion< (String) _optional_: The version vim / neovim that the plugin is targeting. If not present, the version of vim in the available environment is used.
+->toc< (Boolean) _optional_: Whether to generate table of contents or not
 
 
 Example:
@@ -124,7 +116,7 @@ Example:
 
 USING GITHUB ACTIONS                          *panvimdoc-using-github-actions*
 
-Add the following to > ./.github/workflows/pandocvim.yml <:
+Add the following to >./.github/workflows/pandocvim.yml<:
 
 >
     name: panvimdoc
@@ -149,7 +141,7 @@ Add the following to > ./.github/workflows/pandocvim.yml <:
 <
 
 
-Choose > INPUT_FILENAME < and > OUTPUT_FILENAME < appropriately.
+Choose >INPUT_FILENAME< and >OUTPUT_FILENAME< appropriately.
 
 ==============================================================================
 7. References                                           *panvimdoc-references*
@@ -173,8 +165,8 @@ CODEBLOCKS                                              *panvimdoc-codeblocks*
 <
 
 
-Alternatively, you can use > vimdoc < as the language for the code block to
-write code that will be inserted into the final document.
+Alternatively, you can use >vimdoc< as the language for the code block to write
+code that will be inserted into the final document.
 
 For example, the following:
 
@@ -252,15 +244,15 @@ link.
 MAPPINGS                                                  *panvimdoc-mappings*
 
 Any markdown header of level 3 is a special header. It can be used to generate
-documentation of mappings. All content in curly braces > {...} < is dropped and
-a tag is created.
+documentation of mappings. All content in curly braces >{...}< is dropped and a
+tag is created.
 
-The heading > ### pv{motion} < becomes the tag > *projectName-pv* <.
+The heading >### pv{motion}< becomes the tag >*projectName-pv*<.
 
-Additionally, content in square brackets > [...] < is also dropped for creating
+Additionally, content in square brackets >[...]< is also dropped for creating
 the tag name.
 
-The heading > ### :[range]Command < becomes the tag > *projectName-:Command* <.
+The heading >### :[range]Command< becomes the tag >*projectName-:Command*<.
 
 See following headings as examples:
 
@@ -309,7 +301,7 @@ The following vimdoc mapping is generated:
 <
 
 
-You can use > {doc=AdditionalTag} < to generate one additional tag for each
+You can use >{doc=AdditionalTag}< to generate one additional tag for each
 header.
 
                                                                 *panvimdoc-pv*