https://github.com/akrck02/papiro-deploy

Github action to deploy your markdown documents as a web wiki.
https://github.com/akrck02/papiro-deploy

github-action markdown-wiki

Last synced: 8 months ago
JSON representation

Github action to deploy your markdown documents as a web wiki.

• Host: GitHub
• URL: https://github.com/akrck02/papiro-deploy
• Owner: akrck02
• License: mit
• Created: 2025-07-16T21:00:47.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2025-07-19T16:21:38.000Z (11 months ago)
• Last Synced: 2025-09-25T05:46:43.156Z (9 months ago)
• Topics: github-action, markdown-wiki
• Language: Go
• Homepage: https://akrck02.org/papiro
• Size: 21.6 MB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Papiro deploy github action

Deploy your markdown documents as a wiki website on github pages.

## How to install

Create a `publish-docs.yaml` file inside the `.github/workflows` directory with the following configuration:

```yaml

name: Publish documents

on:

  push:

    branches: [main]

permissions:

  contents: write

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v3

      - uses: akrck02/papiro-deploy@main

        with:

          title: "title"              # your project title

          description: "description"  # your project description

          logo: "./logo.svg"          # your logo path (only svg for now)

          path: "./your-docs-path"    # the file with your markdown documents

          isObsidianProject: false    # if it is an obsidian project

          showFooter: true            # if the footer of the page must be shown

          showBreadcrumb: true        # if the breadcrumb of the page must be shown

          showStartPage: true         # if the start page must be shown

      - name: Deploy to github actions 🚀

        uses: JamesIves/github-pages-deploy-action@v4.3.0 # please checkout and give a star to this amazing action.

        with:

          branch: gh-pages            # The branch the action should deploy to.

          folder: .                   # The folder the action should deploy.

```