From 2175df7544da274b096a974080c9845e347213c6 Mon Sep 17 00:00:00 2001 From: frack113 <62423083+frack113@users.noreply.github.com> Date: Sun, 5 Jan 2025 08:40:53 +0100 Subject: [PATCH] =?UTF-8?q?feat:=20=E2=9C=A8=20Add=20mkdocs=20web=20site?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/mkdoc.yaml | 28 ++++++++++++++++++++++++++++ docs/index.md | 11 +++++++++++ docs/logo.svg | 1 + mkdocs.yml | 9 +++++++++ 4 files changed, 49 insertions(+) create mode 100644 .github/workflows/mkdoc.yaml create mode 100644 docs/index.md create mode 100644 docs/logo.svg create mode 100644 mkdocs.yml diff --git a/.github/workflows/mkdoc.yaml b/.github/workflows/mkdoc.yaml new file mode 100644 index 0000000..53f2e10 --- /dev/null +++ b/.github/workflows/mkdoc.yaml @@ -0,0 +1,28 @@ +name: ci +on: + push: + branches: + - 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 diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..0369782 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,11 @@ +# Malware Traces Generator + + +## Build or Run + +To build just type the command ` cargo build -r`. + +To run from source : `cargo run ` + +## to be fill + diff --git a/docs/logo.svg b/docs/logo.svg new file mode 100644 index 0000000..66f6dc9 --- /dev/null +++ b/docs/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b42b1ae --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,9 @@ +site_name: Malware Traces Generator + +theme: + name: readthedocs + highlightjs: true + hljs_languages: + - yaml + - rust + logo: logo.svg \ No newline at end of file