diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 00000000..93abce6e --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,18 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - docs* + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout master + uses: actions/checkout@v1 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/docs/_files/flux-icon.svg b/docs/_files/flux-icon.svg new file mode 100644 index 00000000..36ad500e --- /dev/null +++ b/docs/_files/flux-icon.svg @@ -0,0 +1,22 @@ + + + + flux-icon + Created with Sketch. + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/_files/flux-icon@2x.png b/docs/_files/flux-icon@2x.png new file mode 100644 index 00000000..c6293d30 Binary files /dev/null and b/docs/_files/flux-icon@2x.png differ diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 00000000..0c7edb7a --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,24 @@ +@import url("https://fonts.googleapis.com/css?family=Montserrat&display=swap"); + +body { + font-family: "Montserrat", sans-serif; +} + +.md-logo { + width: 40px; + height: 40px; + padding-bottom: 2px; + padding-top: 2px; +} +.md-logo img { + width: 40px; + height: 40px; +} + +.md-header, .md-footer-nav { + background-image: linear-gradient(45deg, rgb(0, 150, 225) 0%, rgb(27, 141, 226) 24%, rgb(42, 125, 227) 53%, rgb(53, 112, 227) 78%, rgb(53, 112, 227) 100%); +} + +.md-header-nav__title { + font-size: .85rem; +} diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..9da4136e --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +# GitOps Toolkit + +Experimental toolkit for assembling CD pipelines the GitOps way. + +![](diagrams/tk-overview.png) diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..cc77673e --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,50 @@ +site_name: GitOps Toolkit +site_description: Documentation for GitOps Toolkit. +site_author: The Flux contributors +site_url: https://fluxcd.github.io/toolkit/ + +# Repository +repo_name: fluxcd/toolkit +repo_url: https://github.com/fluxcd/toolkit +edit_uri: "" + +theme: + name: material + logo: _files/flux-icon@2x.png + language: en + palette: + primary: blue + accent: indigo + +docs_dir: docs + +extra_css: + - _static/custom.css + +plugins: + - search + +markdown_extensions: + - admonition + - codehilite: + guess_lang: false + - toc: + permalink: true + - pymdownx.superfences: + highlight_code: true + - pymdownx.tabbed + +nav: + - Introduction: introduction.md + - CLI: + - Bootstrap: cmd/tk_bootstrap.md + - Check: cmd/tk_check.md + - Create: cmd/tk_create.md + - Delete: cmd/tk_delete.md + - Export: cmd/tk_export.md + - Get: cmd/tk_get.md + - Install: cmd/tk_install.md + - Resume: cmd/tk_resume.md + - Suspend: cmd/tk_suspend.md + - Synchronize: cmd/tk_sync.md + - Uninstall: cmd/tk_uninstall.md \ No newline at end of file