From 834f7770dccbc1ef7d151fac75ba99a8de385831 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yi=C4=9Fit=20=C3=96zg=C3=BCm=C3=BC=C5=9F?= Date: Sat, 10 Aug 2024 15:06:19 +0300 Subject: [PATCH 1/2] Initialize mkdocs --- docs/index.md | 2 ++ mkdocs.yml | 18 ++++++++++++++++++ 2 files changed, 20 insertions(+) create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..92af107 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,2 @@ +# Welcome to Transmission + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..130d9ea --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,18 @@ +site_name: Transmission +repo_url: https://github.com/trendyol/transmission +theme: + name: material + features: + - content.code.annotate + - content.tabs.link + - content.tooltips + - header.autohide + - navigation.top + - navigation.tracking + - navigation.sections + - navigation.indexes + - navigation.footer + - search.highlight + - search.share + - search.suggest + - toc.integrate From be036aa35cd9f681eaab9e3ab3ea6000b42be904 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yi=C4=9Fit=20=C3=96zg=C3=BCm=C3=BC=C5=9F?= Date: Sat, 10 Aug 2024 15:09:30 +0300 Subject: [PATCH 2/2] Add documentation workflow --- .github/workflows/documentation.yaml | 29 ++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/documentation.yaml diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml new file mode 100644 index 0000000..14215f9 --- /dev/null +++ b/.github/workflows/documentation.yaml @@ -0,0 +1,29 @@ +name: documentation +on: + push: + branches: + - master + - main +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