Skip to content

Commit

Permalink
Update:Adding MKDocs file
Browse files Browse the repository at this point in the history
  • Loading branch information
Salman Malik authored and Salman Malik committed Dec 31, 2023
1 parent 10c9f8b commit a70dd4b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 25 deletions.
36 changes: 11 additions & 25 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,32 +1,18 @@
name: ci
name: Publish docs via GitHub Pages
on:
push:
branches:
- master
- main
permissions:
contents: write

jobs:
deploy:
build:
name: Deploy docs
runs-on: ubuntu-latest
if: github.event.repository.fork == false
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@v4
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
- run: mkdocs gh-deploy --force
env:
GH_TOKEN: ${{ secrets.GH_TOKEN }}
- name: Checkout main
uses: actions/checkout@v1

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
10 changes: 10 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
site_name: Linux Course For Beginners
site_description: 'A linux docs site'
site_author: 'Salman Malik'
docs_dir: docs/
repo_name: 'Linux-Basics-Complete-Course-With-Notes-Slides'
repo_url: 'https://github.com/imsalmanmalik/Linux-Basics-Complete-Course-With-Notes-Slides'
nav:
- Home: index.md
theme:
name: 'material'

0 comments on commit a70dd4b

Please sign in to comment.