-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 9321c45
Showing
7 changed files
with
88 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: Deploy Docs | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build-deploy: | ||
name: Build and deploy docs | ||
|
||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout 🛎️ | ||
uses: actions/checkout@v2 | ||
|
||
- name: Set up Python 3 ⚙️ 🐍 | ||
uses: actions/setup-python@v2 | ||
|
||
- name: Cache dependencies 💾 | ||
uses: actions/cache@v2 | ||
with: | ||
path: ~/.cache/pip | ||
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }} | ||
restore-keys: | | ||
${{ runner.os }}-pip- | ||
${{ runner.os }}- | ||
- name: Install dependencies 🔧 | ||
working-directory: docs | ||
run: make install | ||
|
||
- name: Build and deploy to GitHub Pages 🏗️ 🚀 | ||
working-directory: docs | ||
run: make deploy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
venv | ||
|
||
site/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"python.pythonPath": "venv/bin/python" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
.PHONY: docs | ||
|
||
default: install | ||
|
||
all: install build | ||
|
||
|
||
h help: | ||
@grep '^[a-z]' Makefile | ||
|
||
|
||
install: | ||
pip install pip --upgrade | ||
pip install -r requirements.txt | ||
|
||
upgrade: | ||
pip install pip --upgrade | ||
pip install -r requirements.txt --upgrade | ||
|
||
|
||
s serve: | ||
mkdocs serve --strict | ||
|
||
|
||
b build: | ||
mkdocs build --strict | ||
|
||
d deploy: | ||
mkdocs gh-deploy --strict --force |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# База знаний по принтерам Creality K1, K1 Max, K1C | ||
|
||
[Рускоязычное сообщество в телеграм](https://t.me/crealityK1rus) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
site_name: Creality K1 Wiki | ||
site_description: База знаний по 3D принтерам Creality K1, K1 Max, K1C | ||
site_url: https://siper.github.io/creality-k1-wiki/ | ||
|
||
repo_url: https://github.com/siper/creality-k1-wiki | ||
edit_uri: edit/master/docs/docs | ||
|
||
theme: material | ||
|
||
nav: | ||
- Home: index.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
mkdocs~=1.1,!=1.2 | ||
mkdocs-material |