diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..63bb721b --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,87 @@ +name: Docs + +on: + # Runs on pushes targeting the release branch + push: + branches: + - main + paths: + - 'docs/**' + - 'overrides/**' + - 'mkdocs.yml' + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + + # Listen to a repository dispatch event by the name of `dispatch-event` + repository_dispatch: + types: [dispatch-event] + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + token: ${{ secrets.GH_PAT }} + submodules: true + + # Update references + - name: Update Git Submodules + run: | + git pull --recurse-submodules + git submodule update --remote --recursive + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + + - name: Install Python Dependencies + shell: bash + run: | + python -m venv .linux-venv + source .linux-venv/bin/activate + pip install --upgrade -r requirements.txt + + - name: Build Mkdocs + shell: bash + run: | + export GA_ID=${{ secrets.GA_ID }} + source .linux-venv/bin/activate + mkdocs build + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Upload Built Docs + uses: actions/upload-pages-artifact@v3 + with: + path: './site' + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 + + # Push the updated references + - name: Commit & Push changes + uses: actions-js/push@master + with: + github_token: ${{ secrets.GH_PAT }} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..6d66a8bb --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.venv +.*-venv +.env +site +*.pyc +__pycache__ +.DS_Store \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 00000000..fc2cdb62 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,6 @@ +{ + "cSpell.words": [ + "mkdocs", + "recieve" + ] +} \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 00000000..342b36fd --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,21 @@ +// See https://go.microsoft.com/fwlink/?LinkId=733558 +// for the documentation about the tasks.json format +{ + "version": "2.0.0", + "tasks": [ + { + "label": "Mkdocs Serve", + "command": "mkdocs serve --dev-addr localhost:8080", + "type": "shell", + "group": { + "kind": "build" + }, + "presentation": { + "reveal": "always", + "panel": "shared", + "focus": true + } + } + ], + "inputs": [] +} \ No newline at end of file diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..a628e745 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +docs.polyhammer.com \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..8eb0760a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Shu Ding + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..b8ae1c3f --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Poly Hammer Documentation + +This is where we host all the documentation for our products. Contributions are welcome. If you see something that needs to be changed or updated, feel free to open a Pull request. + +## Usage +First, create a virtual environment `.venv` then run `pip install -r requirements.txt` to install the dependencies. + +Run the command below to pull down the submodules. +```sh +git submodule update --init --recursive +``` + +Then, run the command below to start the development server and visit localhost:8000. +```sh +mkdocs serve +``` \ No newline at end of file diff --git a/docs/assets/images/favicon.ico b/docs/assets/images/favicon.ico new file mode 100644 index 00000000..2ea0e062 Binary files /dev/null and b/docs/assets/images/favicon.ico differ diff --git a/docs/assets/images/hammer-build-tool/create-releases/1.png b/docs/assets/images/hammer-build-tool/create-releases/1.png new file mode 100644 index 00000000..6bb3bfa4 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/create-releases/1.png differ diff --git a/docs/assets/images/hammer-build-tool/create-releases/2.png b/docs/assets/images/hammer-build-tool/create-releases/2.png new file mode 100644 index 00000000..6da41212 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/create-releases/2.png differ diff --git a/docs/assets/images/hammer-build-tool/create-releases/3.png b/docs/assets/images/hammer-build-tool/create-releases/3.png new file mode 100644 index 00000000..64fd70a1 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/create-releases/3.png differ diff --git a/docs/assets/images/hammer-build-tool/create-releases/4.png b/docs/assets/images/hammer-build-tool/create-releases/4.png new file mode 100644 index 00000000..b6e82d70 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/create-releases/4.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/1.gif b/docs/assets/images/hammer-build-tool/setup/1.gif new file mode 100644 index 00000000..3b9ae079 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/1.gif differ diff --git a/docs/assets/images/hammer-build-tool/setup/10.png b/docs/assets/images/hammer-build-tool/setup/10.png new file mode 100644 index 00000000..9fdb92e3 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/10.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/11.png b/docs/assets/images/hammer-build-tool/setup/11.png new file mode 100644 index 00000000..49cdd473 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/11.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/2.png b/docs/assets/images/hammer-build-tool/setup/2.png new file mode 100644 index 00000000..7ea8d2de Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/2.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/3.png b/docs/assets/images/hammer-build-tool/setup/3.png new file mode 100644 index 00000000..1d68027f Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/3.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/4.png b/docs/assets/images/hammer-build-tool/setup/4.png new file mode 100644 index 00000000..401d9aa3 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/4.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/5.png b/docs/assets/images/hammer-build-tool/setup/5.png new file mode 100644 index 00000000..c182fca2 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/5.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/6.png b/docs/assets/images/hammer-build-tool/setup/6.png new file mode 100644 index 00000000..79e64a07 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/6.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/7.png b/docs/assets/images/hammer-build-tool/setup/7.png new file mode 100644 index 00000000..17677534 Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/7.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/8.png b/docs/assets/images/hammer-build-tool/setup/8.png new file mode 100644 index 00000000..de12cccd Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/8.png differ diff --git a/docs/assets/images/hammer-build-tool/setup/9.png b/docs/assets/images/hammer-build-tool/setup/9.png new file mode 100644 index 00000000..a60ed1bc Binary files /dev/null and b/docs/assets/images/hammer-build-tool/setup/9.png differ diff --git a/docs/assets/polyhammer.svg b/docs/assets/polyhammer.svg new file mode 100644 index 00000000..79849292 --- /dev/null +++ b/docs/assets/polyhammer.svg @@ -0,0 +1,25 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/assets/polyhammer_logo.png b/docs/assets/polyhammer_logo.png new file mode 100644 index 00000000..4689a848 Binary files /dev/null and b/docs/assets/polyhammer_logo.png differ diff --git a/docs/examples/example.md b/docs/examples/example.md new file mode 100644 index 00000000..e349612b --- /dev/null +++ b/docs/examples/example.md @@ -0,0 +1,105 @@ +# Color Test Page + +This page is designed to test all the colors used in the Poly Hammer Docs theme. + +## Headings + +### Heading 3 +#### Heading 4 +##### Heading 5 +###### Heading 6 + +## Text + +- **Bold Text** +- *Italic Text* +- ~~Strikethrough Text~~ +- `Inline Code` + +## Links + +- [External Link](https://www.mkdocs.org) +- [Internal Link](../index.md) + +## Lists + +### Unordered List +- Item 1 +- Item 2 + - Subitem 2.1 + - Subitem 2.2 + +### Ordered List +1. First item +2. Second item + 1. Subitem 2.1 + 2. Subitem 2.2 + +## Blockquotes + +> This is a blockquote. + +## Code Blocks + +```python +def hello_world(): + print("Hello, World!") +``` + +## Tables + +| Header 1 | Header 2 | Header 3 | +|----------|----------|----------| +| Row 1 | Data | Data | +| Row 2 | Data | Data | + + + +## Admonitions +!!! note + This is a note. + +!!! tip + This is a tip. + +!!! info + This is some information. + +!!! warning + This is a warning. + +!!! danger + This is a danger alert. + +!!! caution + This is a caution alert. + +!!! success + This is a success message. + +!!! failure + This is a failure message. + +!!! bug + This is a bug alert. + +!!! example + This is an example. + +!!! quote + This is a quote. + + +## Footnote + +Here's a sentence with a footnote. [^1] + +[^1]: This is the footnote. + + +## Subscript & Superscript + +H~2~O + +X^2^ + diff --git a/docs/examples/installation.md b/docs/examples/installation.md new file mode 100644 index 00000000..ac6d6e89 --- /dev/null +++ b/docs/examples/installation.md @@ -0,0 +1,100 @@ +This guide will give you step-by-step instructions on how to download and build the [Meta-Human DNA Addon](https://www.polyhammer.com/metahuman-addon) using the **Poly Hammer Build Tool** + +## Headings + +![Test Image](../assets/polyhammer_logo.png) + +## Text + +- **Bold Text** +- *Italic Text* +- ~~Strikethrough Text~~ +- `Inline Code` + +## Links + +- [External Link](https://www.mkdocs.org) +- [Internal Link](../index.md) + +## Lists + +### Unordered List +- Item 1 +- Item 2 + - Subitem 2.1 + - Subitem 2.2 + +### Ordered List +1. First item +2. Second item + 1. Subitem 2.1 + 2. Subitem 2.2 + +## Blockquotes + +> This is a blockquote. + +## Code Blocks + +```python +def hello_world(): + print("Hello, World!") +``` + +## Tables + +| Header 1 | Header 2 | Header 3 | +|----------|----------|----------| +| Row 1 | Data | Data | +| Row 2 | Data | Data | + + + +## Admonitions +!!! note + This is a note. + +!!! tip + This is a tip. + +!!! info + This is some information. + +!!! warning + This is a warning. + +!!! danger + This is a danger alert. + +!!! caution + This is a caution alert. + +!!! success + This is a success message. + +!!! failure + This is a failure message. + +!!! bug + This is a bug alert. + +!!! example + This is an example. + +!!! quote + This is a quote. + + +## Footnote + +Here's a sentence with a footnote. [^1] + +[^1]: This is the footnote. + + +## Subscript & Superscript + +H~2~O + +X^2^ + diff --git a/docs/examples/quick-start.md b/docs/examples/quick-start.md new file mode 100644 index 00000000..ff8a9939 --- /dev/null +++ b/docs/examples/quick-start.md @@ -0,0 +1,45 @@ + +[Use these Docs for info on how to format content](https://facelessuser.github.io/pymdown-extensions) + +this is _italic_ and so is *this* +this is __bold__ and so is **this** +^^underline^^, ~~strike through~~ +==highlight== and `inline code` +==*you* **can** ^^combine^^ `too`== + + +![Test Image](../assets/polyhammer_logo.png) + + + + +##Task List + +- [X] item 1 + * [X] item A + * [ ] item B + more text + + [x] item a + + [ ] item b + + [x] item c + * [X] item C +- [ ] item 2 +- [ ] item 3 + + +> ``` + a fenced block + ``` + + + +- + ``` + a fenced block + ``` + +Definition +: + ``` + a fenced block + ``` \ No newline at end of file diff --git a/docs/hammer-build-tool/create-releases.md b/docs/hammer-build-tool/create-releases.md new file mode 100644 index 00000000..9aff32d3 --- /dev/null +++ b/docs/hammer-build-tool/create-releases.md @@ -0,0 +1,44 @@ +# Creating Your Own Releases + +As mentioned in the setup, we are not allowed to re-distribute the compiled dependencies needed for our tools. However, you can compile them and create new releases yourself with a simple GitHub workflow. Lets go through an example! + +## Obtain a Product ID +After completing your [purchase](https://www.polyhammer.com/metahuman-addon), you'll recieve an email like the one below. Take note of your `Product ID` as you will need this in the next step. + +
+ Test email +
+ +## Run the Build Tool +Now navigate to your repo that you made in the [setup](./setup.md). Go to the `Actions` tab and select the `Build` workflow and Click on the `Run workflow` dropdown. Enter in your `Product ID`. + +
+ Run workflow +
+ +!!!Note + There are 4 inputs to the build tool workflow: + + a. **Workflow (Product ID)**: This must match the one in your confirmation email. + + b. **Version tag**: Using latest is typically fine, however you can specify a specific release tag if needed. + + c. **Python Version**: This version of python must be compatible with your version of Blender. + + d. **Blender Version**: The version of Blender you intend to use the addon in. + +## Wait for the Build to Complete +After starting the workflow, you will need to wait for the build to complete. This can take some time (~15min or more). Once it finishes running, you will see a release on your repository's page. + +
+ Select addon release +
+ +## Download the Release +Click on this release and download the release attachments. In this example, we can download the addon `meta_human_dna.zip` file here. +
+ Download Meta-Human addon +
+ +## Success! 🎉 +Good work! You have now successfully built and downloaded the release for your product using the [Hammer Build Tool](setup.md)! \ No newline at end of file diff --git a/docs/hammer-build-tool/setup.md b/docs/hammer-build-tool/setup.md new file mode 100644 index 00000000..cb3e3962 --- /dev/null +++ b/docs/hammer-build-tool/setup.md @@ -0,0 +1,100 @@ +# Setup + +Welcome to the hammer build tool setup guide. You can also view our [video tutorial](https://youtu.be/BAyCV8GwmCM) here as well. + +## Why do I need this? + +Some of our tools require additional dependencies that we are not allowed to be re-distributed with our code. However, these dependencies can be complex to compile. That's why we created this build tool. You can run a GitHub workflow and compile all the dependencies needed for our tools yourself. Once you have it configured, it makes it super easy! + +![1](/assets/images/hammer-build-tool/setup/1.gif){: class="rounded-image"} + + +## What are the dependencies? + +1. You must be a part of the [Poly Hammer GitHub org](https://github.com/poly-hammer). Individuals, Small Teams, and Enterprise customers can [purchase access](https://www.polyhammer.com) for a particular build workflow and gain access to the Poly Hammer Org. + +2. You must be a part of the [Epic Games GitHub org](https://github.com/EpicGames). The build tool needs to be able to pull down Unreal Engine source code, so it can compile parts of it for you and your tools. + +3. Copy the template repo and configure its permissions. + + +## What are the steps? + + +### Join Poly Hammer GitHub Org + +1. Purchase a product from the [Poly Hammer website](https://www.polyhammer.com) and open the confirmation email. + +2. Verify your GitHub account by clicking on the `GitHub Verification` button. + +
+ GitHub verify +
+ +3. Authorize the Poly Hammer org to read your primary email tied to your GitHub account. +
+ GitHub authorize +
+!!! Warning + Your email tied to your GitHub account must match the one you used when you purchased the product from the Poly Hammer website. + + +4. After a successful authorization, you will see the page below. +
+ GitHub authentication success +
+ +5. Now check your email and accept the invitation to join the [GitHub Poly Hammer Org](https://github.com/poly-hammer). +
+ GitHub join organization +
+ +Your GitHub account has been verified and you are now a member of the Poly Hammer Org! + +### Join Epic Games GitHub Org + +1. Here is a [detailed guide](https://www.unrealengine.com/ue-on-github) on how to get access to the [Epic Games GitHub Org](https://github.com/EpicGames). +2. Verify that you can now access the source code for [Unreal Engine](https://github.com/EpicGames/UnrealEngine). + +!!! Warning + If you receive a 404 when clicking on [this link](https://github.com/EpicGames/UnrealEngine) while you are logged into GitHub, then your account is not linked correctly to the Epic Games Org, and the build tool will fail. + + +### Copy the Template Repo +1. Go to the [Template](https://github.com/poly-hammer/poly-hammer-build-tool-workflow) repository and click on the `Use this template` button and select the `Create a new repository` option. + +
+ Use template example +
+ +2. Give your repo a name, select `Private` on the visibility section, then hit the `Create repository` button. +
+ Create new repository +
+ +3. Now create a GitHub access token that gives the build tool the proper permissions. To make things simple, you can use this **pre-configured link** to generate a classic token. Copy your token and **hold on to it for a future step**. + +4. Add your newly generated GitHub Token as a secret in your build tool's repo settings. +
+ Repository settings +
+ +Navigate to `Secrets and variables > Actions > New repository secret`. +
+ GitHub actions tab +
+ +Give your token the name `GH_PAT` and paste in your **personal access token that you created in step 3** and click on `Add secret`. +
+ Create actions secret +
+ +You now have an actions secret named `GH_PAT`. +
+ GitHub actions secret +
+ +### Start Building! +:confused: If you still need help configuring your build tool after reading this guide, try watching our [video](https://youtu.be/BAyCV8GwmCM) about it, which goes through the process step by step. + +Whew! :sweat_smile: If you have made it this far, congratulations! You are ready to start [creating your own releases](./create-releases.md)! \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..55122156 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,14 @@ +# Welcome to the Poly Hammer Docs + +## Getting Started + +Welcome to the official documentation for Poly Hammer. Here you'll find everything you need to get started and make the most out of our tool. + +## Useful Links + +- [Poly Hammer Website](https://www.polyhammer.com/) +- [Poly Hammer GitHub Org](https://github.com/poly-hammer) + +## Something missing?🤷‍♂️ + +Feel free to help us out with our [docs on GitHub](https://github.com/poly-hammer/poly-hammer-docs)! \ No newline at end of file diff --git a/docs/quick-start.md b/docs/quick-start.md new file mode 100644 index 00000000..f2fc45f3 --- /dev/null +++ b/docs/quick-start.md @@ -0,0 +1 @@ +# Quick Start Guide diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 00000000..e6d22e7a --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,258 @@ + +[data-md-color-scheme="polyhammer-dark"] .md-typeset h1 { + font-weight: 600; + color: white; +} + +[data-md-color-scheme="polyhammer-light"] .md-typeset h1 { + font-weight: 600; +} + +.md-typeset h2 { + color: var(--md-primary-fg-color--light); + font-weight: 400; +} + +.rounded-image { + border-radius: 5px; + border: #ffffff42 1px solid; +} + +.center-image { + display: block; + margin-left: auto; + margin-right: auto; +} + +.red { + color: #d52a2a; +} + +.green { + color: #0bd570; +} + +.blue { + color: #4287ff; +} + +/* + Gradient coming from header +*/ +[data-md-color-scheme="polyhammer-dark"] .header-gradient{ + background: radial-gradient(70.81% 208.07% at 49.97% 160.07%, #cba03531 0%, #cba0351a 100%); + z-index: -99; + width: 100%; + filter: blur(100px); + height: 20vh; + transform: rotate(180deg); + position: absolute; + top: -10px; + left: 0; +} + +/* + Dark mode color scheme +*/ +[data-md-color-scheme="polyhammer-dark"] { + --md-default-fg-color: #cecece; + --md-default-fg-color--light: #cececed9; + --md-default-fg-color--lighter: #cecece8e; + --md-default-fg-color--lightest: #cecece18; + + --md-default-bg-color: #101010; + --md-default-bg-color--light: #101010b3; + --md-default-bg-color--lighter: #1010104d; + --md-default-bg-color--lightest: #1010101f; + + --md-code-fg-color: #ffffff; + --md-code-bg-color: #7070705e; + --md-code-hl-color: #4287ff; + --md-code-hl-color--light: #4287ff1a; + --md-code-hl-number-color: #d52a2a; + --md-code-hl-special-color: #db1457; + --md-code-hl-function-color: #a846b9; + --md-code-hl-constant-color: #6e59d9; + --md-code-hl-keyword-color: #2d76ff; + --md-code-hl-string-color: #27be2f; + --md-code-hl-name-color: var(--md-code-fg-color); + --md-code-hl-operator-color: var(--md-default-fg-color--light); + --md-code-hl-punctuation-color: var(--md-default-fg-color--light); + --md-code-hl-comment-color: var(--md-default-fg-color--light); + --md-code-hl-generic-color: var(--md-default-fg-color--light); + --md-code-hl-variable-color: var(--md-default-fg-color--light); + + --md-typeset-color: var(--md-default-fg-color); + --md-typeset-a-color: #CBA135; + --md-typeset-del-color: #f54f3da2; + --md-typeset-ins-color: #0bd570a2; + --md-typeset-kbd-color: #fafafa; + --md-typeset-kbd-accent-color: #fff; + --md-typeset-kbd-border-color: #b8b8b8; + --md-typeset-mark-color: #ffff00a2; + --md-typeset-table-color: #ffffff3d; + --md-typeset-table-color--light: rgba(0, 0, 0, .035); + + --md-admonition-fg-color: var(--md-default-fg-color); + --md-admonition-bg-color: var(--md-default-bg-color); + + --md-warning-fg-color: #000000de; + --md-warning-bg-color: #ff9; + + --md-footer-fg-color: #CBA135; + --md-footer-fg-color--light: #ffffffb3; + --md-footer-fg-color--lighter: #ffffff73; + --md-footer-bg-color: #000000; + --md-footer-bg-color--dark: #000000; + + --md-shadow-z1: 0 0.2rem 0.5rem #cba1350d, 0 0 0.05rem #cba1351a; + --md-shadow-z2: 0 0.2rem 0.5rem #cba1351a, 0 0 0.05rem #cba13540; + --md-shadow-z3: 0 0.2rem 0.5rem #0003, 0 0 0.05rem #cba13559; + + --md-primary-fg-color: #0000009c; + --md-primary-fg-color--light: #CBA135; + --md-primary-fg-color--dark: #000000; + + --md-accent-fg-color: #cba035d2; + --md-accent-fg-color--transparent: #cba03557; + --md-accent-bg-color: #fff; + --md-accent-bg-color--light: #ffffffb3; +} + +/* + Light mode color scheme +*/ +[data-md-color-scheme="polyhammer-light"] { + --md-default-fg-color: #000000; + --md-default-fg-color--light: #000000d9; + --md-default-fg-color--lighter: #0000008e; + --md-default-fg-color--lightest: #00000018; + + --md-default-bg-color: #ffffff; + --md-default-bg-color--light: #ffffffb3; + --md-default-bg-color--lighter: #ffffff4d; + --md-default-bg-color--lightest: #ffffff1f; + + --md-code-fg-color: #000000; + --md-code-bg-color: #e6e6e6; + --md-code-hl-color: #4287ff; + --md-code-hl-color--light: #4287ff1a; + --md-code-hl-number-color: #d52a2a; + --md-code-hl-special-color: #db1457; + --md-code-hl-function-color: #a846b9; + --md-code-hl-constant-color: #6e59d9; + --md-code-hl-keyword-color: #3f6ec6; + --md-code-hl-string-color: #1c7d4d; + --md-code-hl-name-color: var(--md-code-fg-color); + --md-code-hl-operator-color: var(--md-default-fg-color--light); + --md-code-hl-punctuation-color: var(--md-default-fg-color--light); + --md-code-hl-comment-color: var(--md-default-fg-color--light); + --md-code-hl-generic-color: var(--md-default-fg-color--light); + --md-code-hl-variable-color: var(--md-default-fg-color--light); + + --md-typeset-color: var(--md-default-fg-color); + --md-typeset-a-color: #CBA135; + --md-typeset-del-color: #f54f3da2; + --md-typeset-ins-color: #0bd570a2; + --md-typeset-kbd-color: #fafafa; + --md-typeset-kbd-accent-color: #fff; + --md-typeset-kbd-border-color: #b8b8b8; + --md-typeset-mark-color: #ffff00a2; + --md-typeset-table-color: #0000003d; + --md-typeset-table-color--light: rgba(0, 0, 0, .035); + + --md-admonition-fg-color: var(--md-default-fg-color); + --md-admonition-bg-color: var(--md-default-bg-color); + + --md-warning-fg-color: #000000de; + --md-warning-bg-color: #ff9; + + --md-footer-fg-color: #CBA135; + --md-footer-fg-color--light: #ffffffb3; + --md-footer-fg-color--lighter: #ffffff73; + --md-footer-bg-color: #000000f0; + --md-footer-bg-color--dark: #000000; + + --md-shadow-z1: 0 0.2rem 0.5rem #cba1350d, 0 0 0.05rem #cba1351a; + --md-shadow-z2: 0 0.2rem 0.5rem #cba1351a, 0 0 0.05rem #cba13540; + --md-shadow-z3: 0 0.2rem 0.5rem #0003, 0 0 0.05rem #cba13559; + + --md-primary-fg-color: #000000; + --md-primary-fg-color--light: #CBA135; + --md-primary-fg-color--dark: #000000; + + --md-accent-fg-color: #cba035d2; + --md-accent-fg-color--transparent: #cba0352f; + --md-accent-bg-color: #fff; + --md-accent-bg-color--light: #ffffffb3; +} + +/* + Frosted Header +*/ +.md-header { + backdrop-filter: blur(10px); +} + +.md-header__button.md-logo img, .md-header__button.md-logo svg { + height: 2rem; +} + +header { + border-bottom: 0.5px solid #333333; +} + +/* + Footer + */ +footer { + border-top: 0.5px solid #333333; +} + + +.md-typeset code { + border-radius: .3rem; +} + + +/* +Remove nav primary and secondary shadows and background +*/ +@media screen and (min-width: 60em) { + .md-nav--secondary .md-nav__title { + background: none; + box-shadow: none; + position: sticky; + top: 0; + z-index: 1; + } +} + +@media screen and (min-width: 76.25em) { + .md-nav--primary .md-nav__title { + background: none; + box-shadow: none; + position: sticky; + top: 0; + z-index: 1; + } +} + +.video-wrapper { + position: relative; + display: block; + height: 0; + padding: 0; + overflow: hidden; + padding-bottom: 56.25%; + } + +.video-wrapper > iframe { + position: absolute; + top: 0; + bottom: 0; + left: 0; + width: 100%; + height: 100%; + border: 0; +} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..6340ed67 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,87 @@ +site_name: Poly Hammer Docs +site_dir: site + +nav: + - Home: index.md + - Hammer Build Tool: + - Setup: hammer-build-tool/setup.md + - Create Releases: hammer-build-tool/create-releases.md + - Fine Grain Access Tokens: hammer-build-tool/fine-grain-access-tokens.md + - Meta-Human DNA Addon: '!include ./meta-human-dna-addon/mkdocs.yml' + +plugins: + - monorepo + +theme: + name: material + custom_dir: "overrides" + logo: assets/polyhammer.svg + favicon: assets/images/favicon.ico + features: + - content.code.copy + - navigation.footer + - search.suggest + + font: + text: Roboto + code: Roboto Mono + + palette: + - scheme: polyhammer-dark + toggle: + icon: material/toggle-switch + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: polyhammer-light + toggle: + icon: material/toggle-switch-off-outline + name: Switch to light mode + +extra_css: + - stylesheets/extra.css + +extra: + analytics: + provider: google + property: !ENV GA_ID + + social: + - icon: simple/x + link: https://x.com/PolyHammerTools + - icon: simple/linkedin + link: https://www.linkedin.com/company/poly-hammer + - icon: simple/github + link: https://github.com/poly-hammer + - icon: simple/youtube + link: https://www.youtube.com/channel/UCBJMFeZQpXmsfR__Ep8Uxow + +plugins: +- monorepo + +markdown_extensions: + - attr_list + - admonition + - footnotes + - sane_lists + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.tilde + - pymdownx.emoji + - pymdownx.mark + - pymdownx.tasklist + - pymdownx.magiclink + - pymdownx.caret + - pymdownx.smartsymbols + - pymdownx.tabbed + - pymdownx.details + - pymdownx.keys + - pymdownx.arithmatex diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 00000000..27db288e --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,6 @@ +{% extends "base.html" %} + +{% block content %} +
+{{ super() }} +{% endblock %} \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..3ccb5375 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +mkdocs==1.6.1 +mkdocs-material==9.5.49 +mkdocs-monorepo-plugin==1.1.0 +mkdocs-material-extensions==1.3.1 \ No newline at end of file