github.com/dancsecs/gotomd@v0.0.0-20240310162206-65c4805cf510/example1/README_SHORT.md (about)

     1  <!--- gotomd::Auto:: See github.com/dancsecs/gotomd **DO NOT MODIFY** -->
     2  
     3  # Package example1
     4  
     5  This project is used by the Szerszam utility function to test its markdown
     6  update methods against an independent standalone project. All features
     7  will be tested against this file so it will be updated and changed often.
     8  
     9  The following will be replaced by the go package documentation
    10  
    11  <!--- gotomd::Bgn::doc::./package -->
    12  ```go
    13  package example1
    14  ```
    15  
    16  Package example1 exists in order to test various go to git
    17  markdown (gToMD) extraction utilities.  Various object will be defined that
    18  exhibit the various comment and declaration options permitted by gofmt.
    19  
    20  # Heading
    21  
    22  This paragraph will demonstrating further documentation under a "markdown"
    23  header.
    24  
    25  Declarations can be single-line or multi-line blocks or constructions.  Each
    26  type will be included here for complete testing.
    27  <!--- gotomd::End::doc::./package -->