https://github.com/ineshbose/wiki-action

Create a sidebar and publish docs from your repo
https://github.com/ineshbose/wiki-action

actions github-actions github-wiki github-wiki-sidebar wiki

Last synced: 1 day ago
JSON representation

Create a sidebar and publish docs from your repo

• Host: GitHub
• URL: https://github.com/ineshbose/wiki-action
• Owner: ineshbose
• License: mit
• Created: 2021-11-13T20:03:44.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-15T17:00:32.000Z (almost 3 years ago)
• Last Synced: 2024-12-04T01:36:44.726Z (20 days ago)
• Topics: actions, github-actions, github-wiki, github-wiki-sidebar, wiki
• Language: Shell
• Homepage:
• Size: 3.91 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wiki Action

A [GitHub Action](https://help.github.com/en/actions) that updates your project's [wiki](https://help.github.com/en/github/building-a-strong-community/about-wikis) **(with a custom sidebar)** from a workflow. **This project is in BETA. Please report bugs if encountered.**

## Usage

```yml

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.**