Skip to content
This repository was archived by the owner on Nov 10, 2025. It is now read-only.

Commit d8d0dcd

Browse files
NoojunoNoojuno
committed
Initial commit
0 parents  commit d8d0dcd

88 files changed

Lines changed: 5103 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy-mkdocs.yml‎

Lines changed: 29 additions & 0 deletions
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‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Godot-specific ignores
2+
.godot/
3+
*.translation
4+
export_presets.cfg
5+
.import/
6+
export/
7+
.mono/
8+
data_*/
9+
mono_crash.*.json
10+
11+
# C# specific
12+
.vs/
13+
.vscode/
14+
obj/
15+
bin/
16+
*.user
17+
*.suo
18+
*.userprefs
19+
*.pidb
20+
*.pdb
21+
*.mdb
22+
*.sln.DotSettings.user
23+
.idea/
24+
**/.DS_Store
25+
26+
# MkDocs specific
27+
site/
28+
venv/
29+
__pycache__/
30+
*.pyc
31+
*.pyo
32+
*.pyd
33+
.Python
34+
pip-log.txt
35+
pip-delete-this-directory.txt
36+
.cache/
37+
.pytest_cache/
38+
39+
# OS-specific
40+
# Windows
41+
Thumbs.db
42+
ehthumbs.db
43+
Desktop.ini
44+
$RECYCLE.BIN/
45+
46+
# macOS
47+
.DS_Store
48+
.AppleDouble
49+
.LSOverride
50+
._*
51+
.Spotlight-V100
52+
.Trashes
53+
54+
# Linux
55+
*~
56+
.directory
57+
.Trash-*
58+
59+
# Node.js/npm (if applicable)
60+
node_modules/
61+
npm-debug.log
62+
63+
# Editor-specific
64+
.vscode/*
65+
!.vscode/settings.json
66+
!.vscode/tasks.json
67+
!.vscode/launch.json
68+
!.vscode/extensions.json
69+
*.code-workspace
70+
.history/

‎README.md‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Coding Knowledge Archive
2+
3+
This repository contains a comprehensive archive of useful coding information, resources, and documentation, built with MkDocs and the Material theme.
4+
5+
## What's Inside
6+
7+
- **General Coding Information**: A growing collection of programming resources and documentation
8+
- **Chickensoft Documentation**: The original documentation for Chickensoft, an open source organization for the C# Godot community
9+
10+
## Setup
11+
12+
1. Install the required dependencies:
13+
14+
```bash
15+
pip install -r requirements.txt
16+
```
17+
18+
2. Run the local development server:
19+
20+
```bash
21+
mkdocs serve
22+
```
23+
24+
This will start a local server at http://127.0.0.1:8000/ where you can preview the documentation.
25+
26+
## Building the Site
27+
28+
To build the static site:
29+
30+
```bash
31+
mkdocs build
32+
```
33+
34+
This will create a `site` directory with the compiled HTML files.
35+
36+
## Automatic Deployment
37+
38+
This repository includes GitHub Actions workflows that automatically build and deploy the documentation site to GitHub Pages whenever changes are pushed to the main branch.
39+
40+
Two workflow options are available:
41+
42+
1. **deploy-docs.yml**: A standard workflow that uses the peaceiris/actions-gh-pages action for deployment.
43+
2. **deploy-mkdocs.yml**: An alternative workflow that uses Python and mkdocs to build and deploy the site.
44+
45+
By default, the site will be deployed to the `gh-pages` branch. To enable GitHub Pages:
46+
47+
1. Go to your repository's Settings > Pages
48+
2. Set the Source to "Deploy from a branch"
49+
3. Select the "gh-pages" branch and "/ (root)" folder
50+
4. Save your changes
51+
52+
The documentation will be available at `https://[username].github.io/[repository]/`
53+
54+
## Structure
55+
56+
- `docs/`: Contains all documentation files
57+
- `docs/index.md`: Main landing page
58+
- `docs/SUMMARY.md`: Navigation definition for literate-nav
59+
- `docs/chickensoft/`: Chickensoft documentation
60+
- `docs/chickensoft/SUMMARY.md`: Navigation definition for Chickensoft section
61+
- `docs/chickensoft/blog/`: Chickensoft blog posts
62+
- `mkdocs.yml`: Configuration file for MkDocs
63+
- `.github/workflows/`: GitHub Actions workflow files for deployment
64+
65+
## Navigation
66+
67+
The site uses the mkdocs-literate-nav plugin for automatic navigation generation. Navigation is defined in `SUMMARY.md` files:
68+
69+
1. The root `docs/SUMMARY.md` defines the main navigation structure
70+
2. Subdirectory `SUMMARY.md` files define navigation for those sections
71+
3. Folders that end with a `/` in the navigation automatically include all files within them
72+
73+
To add new content, simply:
74+
75+
1. Add your Markdown files to the appropriate directory
76+
2. If needed, update the relevant `SUMMARY.md` file or just let the plugin discover them automatically
77+
78+
## Contributing
79+
80+
Contributions to this knowledge archive are welcome! Please feel free to submit pull requests with new content, corrections, or improvements.
81+
82+
## Customization
83+
84+
To customize the site appearance and behavior, edit the `mkdocs.yml` file. See the [MkDocs Material documentation](https://squidfunk.github.io/mkdocs-material/) for more options.

‎docs/SUMMARY.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Site Navigation
2+
3+
- [Home](index.md)
4+
- [Chickensoft](chickensoft/)
5+
- [License](license.md)

‎docs/chickensoft/SUMMARY.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Chickensoft Documentation
2+
3+
- [Home](index.md)
4+
- [Philosophy](philosophy.md)
5+
- [Setup](setup.md)
6+
- [Introspection](introspection.md)
7+
- [How C# Works in Godot](how_csharp_works_in_godot/)
8+
- [Logic Blocks](logic_blocks/)
9+
- [Blog](blog/)

‎docs/chickensoft/blog/authors.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
joanna:
2+
name: 'Joanna'
3+
title: 'Chickensoft Organizer'
4+
url: '/authors/joanna'
5+
image_url: '/img/authors/joanna.jpg'

0 commit comments

Comments
 (0)