Skip to content

Commit

Permalink
initial repo structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Meysam Azad committed Feb 13, 2024
1 parent eedf71d commit ad44c97
Show file tree
Hide file tree
Showing 7 changed files with 173 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: ci

concurrency:
group: ci-${{ github.ref_name }}-${{ github.event_name }}
cancel-in-progress: ${{ ! startsWith(github.ref, 'refs/tags/v') }}

on:
push:
branches:
- main

permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name ${{ github.actor }}
git config user.email ${{ github.actor }}@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-
- name: Install dependencies
run: pip install -U pip -r requirements.txt
- run: mkdocs gh-deploy --force
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site
5 changes: 5 additions & 0 deletions docs/.authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
authors:
meysam:
name: Meysam Azad
description: Writer
avatar: https://github.com/meysam81.png
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Blog
16 changes: 16 additions & 0 deletions docs/posts/hello-world.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
authors:
- meysam
date: 2024-02-13
draft: true
categories:
- hello
---

# Hello world!

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod
nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor
massa, nec semper lorem quam in massa.

<!-- more -->
107 changes: 107 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
site_name: Developer Friendly Blog
edit_uri: blob/main/docs/
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/developer-friendly
name: Check out our GitHub!
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/developerfriendly/
name: Check out our Docker images!
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/developer-friendly
name: Follow us on LinkedIn!
- icon: fontawesome/brands/slack
link: https://communityinviter.com/apps/developerfriendly/join-our-slack
name: Join our Slack!
copyright: Copyright &copy; 2024 Meysam Azad
plugins:
- search:
lang: en
- tags
- glightbox
- offline:
enabled: !ENV [OFFLINE, false]
- social:
enabled: !ENV [CI, false]
cards: true
- blog:
blog_dir: .
# authors_profiles: true
post_readtime: true
blog_toc: true
post_date_format: long
post_readtime_words_per_minute: 238
archive: true
# archive_pagination: true
pagination: true
- group:
enabled: !ENV CI
plugins:
- optimize
- minify
- rss:
enabled: !ENV [CI, false]
match_path: blog/posts/.*
date_from_meta:
as_creation: date
categories:
- categories
- tags
remote_branch: gh-pages
remote_name: origin
repo_name: developer-friendly/blog
repo_url: https://github.com/developer-friendly/blog
site_author: Meysam <[email protected]>
site_description: This repo holds the technical-ish blog of Developer Friendly.
# site_dir: mkdocs
strict: true
theme:
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.code.select
- content.tabs.link
- content.tooltips
- header.autohide
- navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.path
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
font:
code: Roboto Mono
text: Roboto
icon:
repo: fontawesome/brands/github
name: material
palette:
- media: (prefers-color-scheme)
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/brightness-4
name: Switch to system preference
6 changes: 6 additions & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
cairosvg<3
mkdocs-exclude<2
mkdocs-material<10
mkdocs-glightbox<1
mkdocs-rss-plugin<2
pillow==9.5

0 comments on commit ad44c97

Please sign in to comment.