github.com/mweagle/Sparta@v1.15.0/docs_source/themes/hugo-theme-learn/README.md (about)

     1  # Hugo Learn Theme
     2  
     3  This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Grav Learn Theme](https://learn.getgrav.org/).
     4  
     5  Visit the [theme documentation](https://learn.netlify.com/en/) to see what is going on. It is actually built with this theme.
     6  
     7  [![wercker status](https://app.wercker.com/status/233466a2be73fcea400e7dc02ef6adf9/s/master "wercker status")](https://app.wercker.com/project/byKey/233466a2be73fcea400e7dc02ef6adf9)
     8  [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_shield)
     9  
    10  ## Main features
    11  
    12  - Automatic Search
    13  - Multilingual mode
    14  - Unlimited menu levels
    15  - Automatic next/prev buttons to navigate through menu entries
    16  - Image resizing, shadow…
    17  - Attachments files
    18  - List child pages
    19  - Mermaid diagram (flowchart, sequence, gantt)
    20  - Customizable look and feel and themes variants
    21  - Buttons, Tip/Note/Info/Warning boxes, Expand
    22  
    23  ## Installation
    24  
    25  Navigate to your themes folder in your Hugo site and use the following commands:
    26  
    27  ```shell
    28  cd themes/
    29  git clone https://github.com/matcornic/hugo-theme-learn.git
    30  ```
    31  
    32  Check that your Hugo version is minimum `0.25` with `hugo version`.
    33  
    34  ![Overview](https://github.com/matcornic/hugo-theme-learn/raw/master/images/tn.png)
    35  
    36  ## Usage
    37  
    38  - [Visit the documentation](https://learn.netlify.com/en/)
    39  
    40  ## Download old versions (prior to 2.0.0)
    41  
    42  If you need old version for compatibility purpose, either download [theme source code from releases](https://github.com/matcornic/hugo-theme-learn/releases) or use the right git tag. For example, with `1.1.0`
    43  
    44  - Direct download way: https://github.com/matcornic/hugo-theme-learn/archive/1.1.0.zip
    45  - Git way:
    46  
    47  ```shell
    48  cd themes/hugo-theme-learn
    49  git checkout tags/1.1.0
    50  ```
    51  
    52  For both solutions, the documentation is available at https://github.com/matcornic/hugo-theme-learn/releases/download/1.1.0/hugo-learn-doc-1.1.0.zip
    53  
    54  ## Credits
    55  
    56  Many thanks to [@vjeantet](https://github.com/vjeantet/) for the fork [docdock](https://github.com/vjeantet/hugo-theme-docdock). The v2 of this theme is mainly based on his work !
    57  
    58  ## License
    59  
    60  [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmatcornic%2Fhugo-theme-learn?ref=badge_large)
    61  
    62  ## Releasing
    63  
    64  Somewhat work-in-progress steps to release with [gren](https://github.com/github-tools/github-release-notes)
    65  
    66  - Check all MRs assigned to the milestone are closed or pushed back to another release
    67  - Close the milestone
    68  - Check merged MRs on the milestone have a tag (Bug, Enhancement, etc.)
    69  - Tag and push the repo
    70  
    71    ```shell
    72    git tag <tag>
    73    git push origin <tag>
    74    ```
    75  
    76  - Generate CHANGELOG.md with _gren_
    77  
    78    ```shell
    79    gren changelog  --override --generate --tags=all
    80    ```
    81  
    82  - Fix the date for the current release in CHANGELOG.md
    83  - Add the changelog to git and update the tag
    84  
    85    ```shell
    86    git add CHANGELOG.md
    87    git commit -m "Ship tag <tag>"
    88    git push origin master
    89    git tag -f <tag>
    90    git push --force origin <tag>
    91    ```
    92  
    93  - Generate release with _gren_
    94  
    95    ```shell
    96    gren release -t <tag>
    97    ```