v0.1

.github/workflows/build-deploy-docs.yml

@@ -0,0 +1,35 @@
+name: "DOC - Build and deploy - Beta"
+on:
+  push:
+    branches:
+      - main
+      - development
+      - docs
+    paths:
+      - "docs/**"
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    if: github.repository == 'oxsecurity/codetotal'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/[email protected]
+        with:
+          python-version: 3.10.4
+      - run: pip install --upgrade markdown==3.3.7 mkdocs-material pymdown-extensions==9.11 mkdocs-glightbox==0.3.2 mdx_truly_sane_lists
+      - run: |
+          git config --global user.name megalinter-bot
+          git config --global user.email [email protected]
+      - run: mkdocs gh-deploy --force
+
+

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased] (beta, main branch content)
+
+Initial version

CONTRIBUTING.md

@@ -1,4 +1,4 @@
- # Contributing to MegaLinter
+ # Contributing to CodeTotal
 
 - [Development Mode](#development-mode)
 - [Available Scripts](#available-scripts)

README.md

@@ -1,5 +1,9 @@
 # CodeTotal
 
-![CodeTotal Screenshot](docs/assets/images/screen.jpg "A screenshot from the app")
+**CodeTotal** analyzes any **snippet**, **file**, or **repository** to detect possible **security flaws** such as **secret in code**, **open source vulnerability**, **code security**, **vulnerability**, insecure **infrastructure as code**, and potential **legal issues** with open source licenses.
 
+Brought to you by [OX Security](https://ox.security), powered by [MegaLinter](https://megalinter.io)
 
+[![CodeTotal Screenshot](docs/assets/images/screen.jpg "A screenshot from the app")](https://codetotal.io)
+
+To see how to use CodeTotal, please read [online documentation](https://codetotal.io) :)

docs/CHANGELOG.md

@@ -0,0 +1 @@
+--8<-- "../CHANGELOG.md"

docs/contributing.md

@@ -0,0 +1 @@
+--8<-- "../CONTRIBUTING.md"

docs/index.md

@@ -0,0 +1,7 @@
+# CodeTotal
+
+**CodeTotal** analyzes any **snippet**, **file**, or **repository** to detect possible **security flaws** such as **secret in code**, **open source vulnerability**, **code security**, **vulnerability**, insecure **infrastructure as code**, and potential **legal issues** with open source licenses.
+
+Brought to you by [OX Security](https://ox.security), powered by [MegaLinter](https://megalinter.io)
+
+![CodeTotal Screenshot](assets/images/screen.jpg "A screenshot from the app")

docs/license-explanations.md

@@ -0,0 +1,29 @@
+---
+title: License explanation
+description: What you can do and can not do with CodeTotal
+---
+<!-- markdownlint-disable MD013 -->
+
+# Why AGPL V3 License ?
+
+CodeTotal is an open-source and free tool graciously provided to the developer community.
+
+We don't earn money with CodeTotal, but it takes a lot of time to maintain it, so we want to avoid companies to make money with it by selling software or services without sharing their sources, like it happened in the past with [ElasticSearch](https://www.elastic.co/blog/why-license-change-aws) or [MongoDB](https://techcrunch.com/2018/10/16/mongodb-switches-up-its-open-source-license/).
+
+## What you can do
+
+- Use CodeTotal with public repositories
+- Use CodeTotal with private repositories, even commercial ones
+- Use CodeTotal to build commercial closed-source applications
+- Use CodeTotal with on-premise Git services, like Github Enterprise or Gitlab Community Edition
+
+## What you can not do
+
+- Sell CodeTotal
+- Expose a closed-source online service that calls CodeTotal in the background
+
+## What you could do
+
+If you have a professional use of CodeTotal, you can be nice and support us by [sponsoring us](https://megalinter.io/latest/sponsor/), and ask your clients to sponsor us too :)
+
+Any questions ? [Contact us](https://www.ox.security/contact/) !

docs/license.md

@@ -0,0 +1,5 @@
+# License
+
+## GNU Affero General Public License
+
+    --8<-- "../LICENSE"

docs/overrides/main.html

@@ -0,0 +1,32 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+
+{% if page and page.meta and page.meta.title and page.meta.description %}
+<meta name="twitter:image:src" content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" />
+<meta name="twitter:site" content="@nvuillam" />
+<meta name="twitter:card" content="summary_large_image" />
+<meta name="twitter:title" content="{{ page.meta.title }}" />
+<meta name="twitter:description" content="{{ page.meta.description }}" />
+<meta property="og:image" content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" />
+<meta property="og:image:alt" content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." />
+<meta property="og:site_name" content="CodeTotal" />
+<meta property="og:title" content="{{ page.meta.title }}" />
+<meta property="og:description" content="{{ page.meta.description }}" />
+{% else %}
+<meta property="description" content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." />
+<meta name="twitter:image:src" content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" />
+<meta name="twitter:site" content="@nvuillam" />
+<meta name="twitter:card" content="summary_large_image" />
+<meta name="twitter:title" content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." />
+<meta name="twitter:description" content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." />
+<meta property="og:image" content="https://github.com/oxsecurity/codetotal/raw/main/docs/assets/images/mega-linter-logo.png" />
+<meta property="og:image:alt" content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." />
+<meta property="og:site_name" content="CodeTotal" />
+<meta property="og:type" content="object" />
+<meta property="og:title" content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." />
+<meta property="og:url" content="https://codetotal.io" />
+<meta property="og:description" content="🦙 CodeTotal analyzes any snippet, file, or repository to detect possible security flaws such as secret in code, open source vulnerability, code security, vulnerability, insecure infrastructure as code, and potential legal issues with open source licenses." />
+{% endif %}
+
+{% endblock %}

package.json

@@ -21,6 +21,8 @@
     "codetotal:dev": "cross-env DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f docker-compose-local.yml up",
     "precodetotal": "cross-env DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f docker-compose.yml pull",
     "codetotal": "cross-env DOCKER_DEFAULT_PLATFORM=linux/amd64 docker-compose -f docker-compose.yml up",
+    "doc:install": "pip install --upgrade markdown==3.3.7 mkdocs-material pymdown-extensions==9.11 mkdocs-glightbox==0.3.2 mdx_truly_sane_lists",
+    "doc:test": "mkdocs serve",
     "e2e": "npx cypress open"
   },
   "pre-commit": [