Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
Created from https://vercel.com/new

changed logo

fixed logo link

switched to mkdocs

Styled docs and uploaded examples

added vercel dependencies

updated vercel

updated vercel

updateds to vercel

updates to vercel

updates to vercel

vercel updates

updates

Add Vercel configuration for Python and static builds

updates to vercel

updates

site added

swapped default theme

styling updates

updated build

footer styling updates

updated build tool docs, removed fine grain access docs

change depolyment method to github pages

Updated Readme

removed site folder

changed target branch to main

added cname file

images for emails and og

fixed google analytics

removed images

updated ENV

Added mono-repo plugin and meta-human-dna addon

Added mono-repo plugin and meta-human-dna addon

Added setup and running workflows docs to the docs site

refactored the hammer build tool docs

refactored the hammer build tool docs

updated workflow

updated CI

fixed links

removed fine grain access md file

removed typo

removed note.

added video links

added repository_dispatch trigger

reset meta-human-dna docs

removed submodule

fixed mono repo

Added automatic syncing of submodules

added style for video iframe

chore: autopublish 2025-01-22T22:57:17Z

chore: autopublish 2025-01-23T01:56:42Z

chore: autopublish 2025-01-23T17:53:35Z

chore: autopublish 2025-01-23T20:26:05Z

fixed typos, minor formatting

update

update meta human dna addon docs

Removed submodule

added back submodule

Removed submodule

removed linux venv
  • Loading branch information
polyhammer-bot authored and jack-yao91 committed Jan 24, 2025
0 parents commit 6c04c0d
Show file tree
Hide file tree
Showing 36 changed files with 948 additions and 0 deletions.
87 changes: 87 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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 }}
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.venv
.*-venv
.env
site
*.pyc
__pycache__
.DS_Store
6 changes: 6 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"cSpell.words": [
"mkdocs",
"recieve"
]
}
21 changes: 21 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -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": []
}
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
docs.polyhammer.com
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```
Binary file added docs/assets/images/favicon.ico
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/hammer-build-tool/setup/9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 25 additions & 0 deletions docs/assets/polyhammer.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/polyhammer_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
105 changes: 105 additions & 0 deletions docs/examples/example.md
Original file line number Diff line number Diff line change
@@ -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^

Loading

0 comments on commit 6c04c0d

Please sign in to comment.