Skip to content

Commit f0ddd34

Browse files
committed
Initial build of the skeleton site
This is the start! Signed-off-by: JJ Asghar <[email protected]>
1 parent 0252dcf commit f0ddd34

File tree

5 files changed

+80
-0
lines changed

5 files changed

+80
-0
lines changed

.github/workflows/ci.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- main
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Configure Git Credentials
15+
run: |
16+
git config user.name github-actions[bot]
17+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
18+
- uses: actions/setup-python@v5
19+
with:
20+
python-version: 3.x
21+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
22+
- uses: actions/cache@v4
23+
with:
24+
key: mkdocs-material-${{ env.cache_id }}
25+
path: .cache
26+
restore-keys: |
27+
mkdocs-material-
28+
- run: pip install mkdocs-material
29+
- run: mkdocs gh-deploy --force

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
venv*

docs/index.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Welcome to MkDocs
2+
3+
For full documentation visit [mkdocs.org](https://www.mkdocs.org).
4+
5+
## Commands
6+
7+
* `mkdocs new [dir-name]` - Create a new project.
8+
* `mkdocs serve` - Start the live-reloading docs server.
9+
* `mkdocs build` - Build the documentation site.
10+
* `mkdocs -h` - Print help message and exit.
11+
12+
## Project layout
13+
14+
mkdocs.yml # The configuration file.
15+
docs/
16+
index.md # The documentation homepage.
17+
... # Other markdown pages, images and other files.

mkdocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
site_name: docs.instructlab.ai
2+
site_url: https://docs.instructlab.ai
3+
theme:
4+
name: material

requirements.txt

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
babel==2.16.0
2+
certifi==2024.7.4
3+
charset-normalizer==3.3.2
4+
click==8.1.7
5+
colorama==0.4.6
6+
ghp-import==2.1.0
7+
idna==3.8
8+
Jinja2==3.1.4
9+
Markdown==3.7
10+
MarkupSafe==2.1.5
11+
mergedeep==1.3.4
12+
mkdocs==1.6.0
13+
mkdocs-get-deps==0.2.0
14+
mkdocs-material==9.5.33
15+
mkdocs-material-extensions==1.3.1
16+
packaging==24.1
17+
paginate==0.5.7
18+
pathspec==0.12.1
19+
platformdirs==4.2.2
20+
Pygments==2.18.0
21+
pymdown-extensions==10.9
22+
python-dateutil==2.9.0.post0
23+
PyYAML==6.0.2
24+
pyyaml_env_tag==0.1
25+
regex==2024.7.24
26+
requests==2.32.3
27+
six==1.16.0
28+
urllib3==2.2.2
29+
watchdog==5.0.0

0 commit comments

Comments
 (0)