ineshbose / wiki-action

Create a sidebar and publish docs from your repo

Wiki Action

A GitHub Action that updates your project's wiki (with a custom sidebar) from a workflow. This project is in BETA. Please report bugs if encountered.

Usage

name: Update Wiki

# on: [push]

# recommended
on:
  push:
    paths:
      - 'wiki/**'
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v1

      - uses: ineshbose/wiki-action@v1
        with:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          WIKI_DIR: 'wiki'
          AUTO_SIDEBAR: true

Argument	Required	Default	Description
GH_TOKEN	Yes		GitHub Token required to make changes. You can use ${{ secrets.GITHUB_TOKEN }}.
WIKI_DIR	No	wiki	The directory relative to the repository root where the wiki files are.
WIKI_IGNORE	No		Files and directories (separated with a space) that are not supposed to be on the wiki (and sidebar).
AUTO_SIDEBAR	No	False	Add files onto _Sidebar.md for the Wiki according to the directory structure.
SIDEBAR_IGNORE	No		Files and directories (separated with a space) that are not supposed to be listed on the sidebar.

Sidebar Customisation

You can still create a _Sidebar.md with your project logo and more listings on it, and the rest of the items will be added towards the end. Make sure that the file ends with an empty line.