-
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
1 parent
9f2d5bd
commit 4dc8633
Showing
308 changed files
with
1,437 additions
and
3,277 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
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 @@ | ||
* @suneeta-mall |
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,21 @@ | ||
name: Docs | ||
on: | ||
push: | ||
#branches: | ||
# - main | ||
permissions: | ||
contents: write | ||
jobs: | ||
deploy: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.10' | ||
|
||
- name: install publishing dependencies | ||
run: make install | ||
|
||
- name: Deploy pages | ||
run: mkdocs gh-deploy --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,11 @@ | ||
on: | ||
workflow_dispatch: | ||
|
||
name: Renovate | ||
|
||
jobs: | ||
check_dependencies: | ||
name: Check dependencies | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v4 |
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 |
---|---|---|
@@ -1,6 +1,84 @@ | ||
_site/ | ||
.sass-cache/ | ||
.jekyll-metadata | ||
.jekyll-cache | ||
.idea | ||
.coverage | ||
.mypy_cache/ | ||
.pip.conf | ||
.pytest_cache/ | ||
.pytest_logs/ | ||
lightning_logs/ | ||
.venv/ | ||
.vscode | ||
__pycache__ | ||
|
||
# Distribution / packaging | ||
.Python | ||
build/ | ||
develop-eggs/ | ||
dist/ | ||
downloads/ | ||
eggs/ | ||
.eggs/ | ||
lib/ | ||
lib64/ | ||
parts/ | ||
sdist/ | ||
var/ | ||
wheels/ | ||
*.egg-info/ | ||
.installed.cfg | ||
*.egg | ||
MANIFEST | ||
outputs/ | ||
artifacts/ | ||
|
||
# PyInstaller | ||
# Usually these files are written by a python script from a template | ||
# before PyInstaller builds the exe, so as to inject date/other infos into it. | ||
*.manifest | ||
*.spec | ||
|
||
# Installer logs | ||
pip-log.txt | ||
pip-delete-this-directory.txt | ||
|
||
# Unit test / coverage reports | ||
htmlcov/ | ||
.tox/ | ||
.coverage | ||
.coverage.* | ||
.cache | ||
nosetests.xml | ||
coverage.xml | ||
*.cover | ||
.hypothesis/ | ||
.pytest_cache/ | ||
|
||
|
||
# Crash log files | ||
crash.log | ||
*.log | ||
|
||
# Envvars environment configuration file | ||
.env | ||
.envrc | ||
.venv | ||
env/ | ||
venv/ | ||
ENV/ | ||
env.bak/ | ||
venv.bak/ | ||
.direnv | ||
.envrc/ | ||
.vscode/ | ||
.pip.conf | ||
.requirements-no-hashes.txt | ||
.python-version | ||
|
||
# Jupyter Notebook | ||
.ipynb_checkpoints | ||
|
||
# Temporary caches | ||
*.so | ||
cache/* | ||
.tmp | ||
site | ||
|
||
.DS_Store |
This file was deleted.
Oops, something went wrong.
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 @@ | ||
.PHONY: install serve clean | ||
.DEFAULT_GOAL := serve | ||
|
||
install: | ||
pip install -r requirements.txt | ||
|
||
serve: | ||
mkdocs serve | ||
|
||
clean: | ||
git clean -Xdf |
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 |
---|---|---|
@@ -1,15 +1,30 @@ | ||
# Blogs and pages | ||
Personal blog and pages powered by [Jekyll](https://github.com/jekyll/jekyll) & [Polar](https://github.com/neizod/polar). | ||
# Random Musings | ||
|
||
# Run Locally | ||
TODO @suneeta | ||
|
||
|
||
# Setup Dev | ||
|
||
To launch mkdocs locally, follow these instructions: | ||
|
||
1. Create a Python environment: | ||
```bash | ||
jekyll clean | ||
jekyll serve --watch | ||
python3 -m venv .venv | ||
. .venv/bin/activate | ||
``` | ||
|
||
1. Install the dependencies: | ||
```bash | ||
make install | ||
``` | ||
|
||
|
||
1. Start the serving endpoint: | ||
```bash | ||
make serve | ||
``` | ||
docker build -t blog . | ||
docker run -ti -p 4000:4000 -v `pwd`:`pwd` -w `pwd` --name=blog blog | ||
``` | ||
|
||
# TODO | ||
[] Add Dep and version lock upgrade | ||
[] Use bib for references | ||
[] Add annoucement of books https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-header/ | ||
[] Format content with https://squidfunk.github.io/mkdocs-material/reference/admonitions/ |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.