{"id":21961272,"url":"https://github.com/yforku/251docs","last_synced_at":"2026-04-09T11:47:40.319Z","repository":{"id":274548508,"uuid":"896031257","full_name":"yforku/251docs","owner":"yforku","description":"251docs","archived":false,"fork":false,"pushed_at":"2024-11-29T12:24:00.000Z","size":973,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-28T00:32:35.464Z","etag":null,"topics":["mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://yforku.github.io/251docs/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yforku.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-29T12:06:10.000Z","updated_at":"2024-11-29T12:24:46.000Z","dependencies_parsed_at":"2025-01-28T00:32:36.675Z","dependency_job_id":"2af7e10f-b833-4efa-8a6d-f99f8f990183","html_url":"https://github.com/yforku/251docs","commit_stats":null,"previous_names":["yforku/251docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yforku%2F251docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yforku%2F251docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yforku%2F251docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yforku%2F251docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yforku","download_url":"https://codeload.github.com/yforku/251docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245016285,"owners_count":20547572,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","mkdocs-material"],"created_at":"2024-11-29T10:14:26.667Z","updated_at":"2025-12-30T23:43:55.090Z","avatar_url":"https://github.com/yforku.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 251docs by YFORKU!\n\n[\u0026#x213C;](#idxXXX)\u003cbr id=\"idx000\"\u003e\n## Table of Content (Toc)\n* [Network Address Translation (NAT) Settings](#idx001)\n  * [VirtualBox](#idx001)\n  * [UTM](#idx001a)\n* [GitHub Repo 251docs](#idx002)\n* [Debian Packages](#idx003)\n* [CLONE Your GitHub Repo on VirtualBox](#idx004)\n* [File .gitignore](#idx005)\n* [Check Python, Pip, and Venv](#idx006)\n* [Python Virtual Environment](#idx007)\n* [Activate the Virtual Environment](#idx008)\n* [MkDocs and Plugins](#idx009)\n* [MkDocs inside folder \"docs/\"](#idx010)\n* [File: \"mkdocs.yml\"](#idx11)\n* [Test from VirtualBox](#idx012)\n* [Build the MkDocs site](#idx013)\n* [Switch to gh-pages branch and back to master](#idx014)\n\n[\u0026#x213C;](#)\u003cbr id=\"idx001\"\u003e\n## Network Address Translation (NAT) Settings\n\n### VirtualBox\n\nMkDocs is using local port 8000. \nOn your VirtualBox, you must redirect/translate the local port 8000 to the host port 4999.\nI am already using 5000 for Jekyll and 5001 for Docusaurus.\n\n* VirtualBox Settings\n  * Network:Adapter1:\n    * Enable Network Adapter\n    * Attached to: NAT\n    * Port Forwarding:\n      * 127.0.0.1:4999 (Host) --- 10.0.2.15:8000 (Guest)\n\n\u003cbr\u003e\u003cimg src=\"images/VBOX-NAT.jpg\"  width=\"960\"\u003e\u003cbr\u003e\n\n[\u0026#x213C;](#)\u003cbr id=\"idx001a\"\u003e\n\n### UTM\n\nMkDocs is using local port 8000. \nOn your UTM, you must redirect/translate the local port 8000 to the host port 4999.\nI am already using 5000 for Jekyll and 5001 for Docusaurus.\n\n* UTM Settings\n  * Network Mode: Emulated VLAN\n    * Port Forward: New\n      * Protocol: TCP\n      * Guest Address: 10.0.2.15\n      * Guest Port: 8000\n      * Host Address: 127.0.0.1\n      * Host Port: 4999\n   * SAVE\n\n\u003cbr\u003e\u003cimg src=\"images/debM1-forward.jpg\"  width=\"960\"\u003e\u003cbr\u003e\n\n[\u0026#x213C;](#)\u003cbr id=\"idx002\"\u003e\n## GitHub Repo 251docs\n\n* Create a new [GitHub](https://github.com/) repo.\n  * New Repository\n  * Repository Name: \"251docs\"\n  * Description: \"251docs\"\n  * Public\n  * Add README.md\n  * Add .gitignore: Python (temporary)\n  * Choose any free LICENSE\n  * See also \u003chttps://doit.vlsm.org/030.html\u003e\n* Create a GitHub page.\n  * (Create branch: gh-pages), apparently will automatically create a GitHub Page?!\n  * See also \u003chttps://doit.vlsm.org/031.html\u003e\n\n[\u0026#x213C;](#)\u003cbr id=\"idx003\"\u003e\n## Debian Packages\n\nMake sure the following Debian packages are present in your system.\n\n```\n# USER privilege.\nexport DEBS=\"\naptitude\nbuild-essential\ngit\nlibffi-dev\nlibssl-dev\npython3\npython3-dev\npython3-pip\npython3-venv\nsudo\nvim\n\"\ntime sudo apt-get install $DEBS -y\ndate\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx004\"\u003e\n## CLONE Your GitHub Repo on VirtualBox\n* E.g. repo \"251docs/\"\n\n```\n# YOU ARE NOT YFORKU!\nGITHUB=\"yforku\"\n\nREPO=\"251docs\"\ngit clone git@github.com:$GITHUB/$REPO.git\ncd $REPO/\n\n```\n* REMEMBER: You are not **YFORKU**!\n* Write your memo on file \"README.md\".\n  * Update/push \"README.md\" regularly.\n\n[\u0026#x213C;](#)\u003cbr id=\"idx005\"\u003e\n### File .gitignore\n\nIf you still not, go to (cd) repo \"251docs/\".\nCopy the following into your .gitignore file:\n\n```\n# REVISI: Fri 29 Nov 2024 16:00\n# STARTX: Thu 28 Nov 2024 17:00\n\n# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# Distribution / packaging\n.Python\nenv/\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nnode_modules/\nparts/\nsdist/\nvar/\npackage*.json\n*.egg-info/\n.installed.cfg\n*.egg\n\n# PyInstaller\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n*.log\n\n# Unit test / coverage reports\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*,cover\n.hypothesis/\n\n# Virtualenv\nvenv/\nENV/\n\n# MkDocs documentation\nsite*/\n\n# Translations\n*.mo\n\n# Scrapy stuff:\n.scrapy\n\n# PyBuilder\ntarget/\n\n# IPython Notebook\n.ipynb_checkpoints\n\n# pyenv\n.python-version\n\n# Miscellaneous\n.mkdocs-env/\n*.tmp\n.DS_Store\n*.swp\n\n```\n\n\n\n[\u0026#x213C;](#)\u003cbr id=\"idx006\"\u003e\n## Check Python, Pip, and Venv\n\n```\npython --version\npip --version\npython -m venv --help\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx007\"\u003e\n## Python Virtual Environment\n\n```\n# A centralized \".virtualenvs/\" directory\nmkdir -pv ~/.virtualenvs/\n\n# Create a Virtual Environment\npython3 -m venv ~/.virtualenvs/$(basename $(pwd))\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx008\"\u003e\n## Activate the Virtual Environment\n* Before working with \"MkDocs\", always activate the virtual environment!\n\n```\nsource ~/.virtualenvs/$(basename $(pwd))/bin/activate\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx009\"\u003e\n## Install MkDocs and additional MkDocs plugins\n\n* Upgrade, Clean Up, and Verify Version\n\n```\npip install --upgrade pip mkdocs mkdocs-material\necho \"= =======================================\"\npip --version\nmkdocs --version\npip cache purge\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx010\"\u003e\n## MkDocs inside folder \"docs/\"\n\n```\nmkdir -pv docs/\ncd docs/\nmkdocs new .\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx011\"\u003e\n## File: mkdocs.yml \n\n```\nsite_name: 252docs\n\n```\n\n\n[\u0026#x213C;](#)\u003cbr id=\"idx012\"\u003e\n## Test from VirtualBox\n\n* Check it out at \"localhost:4999\" (HOST)\n\n```\nmkdocs serve --dev-addr=0.0.0.0:8000\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx013\"\u003e\n## Build the MkDocs site\n* Build, commit, and push (master)\n\n```\ngit add .\ngit commit -m \"Save uncommitted changes\"\ngit push\n\n```\n\n[\u0026#x213C;](#)\u003cbr id=\"idx014\"\u003e\n## Deploy\n\n```\nmkdocs gh-deploy --force --clean\ngit checkout gh-pages\necho \"Checkit out at \u003chttps://yforku.github.io/251docs/\u003e, but your are not YFORKU!\" \u003e README.md\ngit add .\ngit commit -m \"Include a README.md in gh-pages\"\ngit push origin gh-pages\ngit checkout master\n\n```\n\n* Checkit out at \u003chttps://yforku.github.io/251docs/\u003e, but your are not YFORKU!\n\n\u003chr\u003e\n\n```\nREVISI: Fri 29 Nov 2024 19:01\nREVISI: Fri 29 Nov 2024 18:00\nREVISI: Fri 29 Nov 2024 17:08\nREVISI: Fri 29 Nov 2024 15:00\nREVISI: Fri 29 Nov 2024 14:04\nSTARTX: Tue 26 Nov 2024 12:00\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyforku%2F251docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyforku%2F251docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyforku%2F251docs/lists"}