Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 added documentation using mkdocs #166

Closed
wants to merge 5 commits into from

Conversation

vishalkadam47
Copy link
Contributor

Documentation using MkDocs

here's a quick deployment using cloudflare for review https://selkies-gstreamer.pages.dev/

I tried this 👇 but I guess because of Pages on this forked repository is disabled I'm not able to deploy

name: docs
on:
  push:
    branches:
      - docs
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: .cache
          restore-keys: |
            mkdocs-material-
      - run: pip install mkdocs-material
      - run: mkdocs gh-deploy --force

@ehfd
Copy link
Member

ehfd commented Oct 29, 2024

Refactored and superseded by 0989204

@vishalkadam47 @PMohanJ Both of you were credited in the commit. Thank you all.

@ehfd ehfd closed this Oct 29, 2024
@vishalkadam47 vishalkadam47 deleted the mkdocs branch November 1, 2024 05:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants