Skip to content

Papiro deploy

Actions
Publish markdown documents as a website
v0.0.3
Latest
Star (2)

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:

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/[email protected] # 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.

Papiro deploy is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Publish markdown documents as a website
v0.0.3
Latest

Papiro deploy is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.