dev-insights-tips

A repository that gathers insights and tips for development.
It aims to share information related to programming and development.

URL

Content(website) is managed by GitHub Pages.

https://7rikazhexde.github.io/dev-insights-tips/

Usage

For local

If you want to launch website in a local repository, do the following.

git clone https://github.com/7rikazhexde/dev-insights-tips.git

🚨 Note:
This project assumes that you have installed Poetry For Poetry installation, check the official website.

poetry install

🚨 Note:
When using the pip command, please create a virtual environment in the pyenv-virtualenv environment and retrieve the package. The pip command should also retrieve packages for development (requirements-dev.txt).

pyenv virtualenv [version] [virtual environment name]
pyenv local [virtual environment name]
pip install -r requirements.txt
pip install -r requirements-dev.txt

create .git/hooks/pre-commit

ℹ️ Note:
Create pre-commit and post-commit if you want to automate version updates of Pyproject.toml and tag. Reference

poetry run pre-commit install

ℹ️ Note:
When I set pre-commit-hooks and checked the operation, I confirmed that the files under the site folder were modified multiple times. Considering the commit process, I determined that there was no need to include files under the site folder in the hook process. Therefore, I decided to add a Python script that excludes files under the generated site folder and set them to be excluded.

The following script can be executed to include them in the exclude list.

poetry run python ci/set_pre-commit-hooks_exclude.py

create .git/hooks/post-commit

chmod +x create_post-commit.sh
./create_post-commit.sh

Launch local website

Execute the following command to access the URL displayed. Check mkdocs for details.

• https://www.mkdocs.org/
• https://squidfunk.github.io/mkdocs-material/

poetry run mkdocs serve

Update dpcuments

Add or update content (.md) under docs. Then execute the following command.

poetry run mkdocs build -c
poetry run mkdocs serve

For remote (GitHub Pages)

Content is built using Github Actions and deployed to GitHub Pages.
Please check the following for the contents of the configuration file. (Basically, no change is necessary.)

.github/workflows/push_gh-deploy.yml