docu-lite

Adding docu-lite to your GitHub workflow

Here’s how to ensure that you create an up to date outline on every commit.

Create a file called something like this (the name doesn’t matter, but the file location does):

   your-repository/.github/workflows/update_overviews.yml

Here’s mine: update_overviews.yml

Make sure that you edit the lines

      - name: Run docu-lite
        run: |
          docu-lite

      - name: Run docu-lite in docmode
        run: |
          docu-lite --config docu-lite-docmode.ini

so that docu-lite points to your .ini file(s), and edit the ini files as described in usage section of the README.

Ensure that you have read/write permissions set for your actions

Go to the repository settings:

Then, on the side bar:

Finally, on the bottom of the page

That’s it

Once that’s done, you should have an html file appear where you specified, which you can then edit to create a new user guide or have GitHub pages automatically serve to the web.

This site is open source. Improve this page.