https://github.com/bhazel/bwhazel-info-web-site
Source code my info web site, including technical and legal details.
https://github.com/bhazel/bwhazel-info-web-site
Last synced: about 1 year ago
JSON representation
Source code my info web site, including technical and legal details.
- Host: GitHub
- URL: https://github.com/bhazel/bwhazel-info-web-site
- Owner: BHazel
- Created: 2021-03-27T09:43:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-15T22:01:18.000Z (over 1 year ago)
- Last Synced: 2025-01-15T23:50:49.408Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 31.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# BWHazel Info Web Site
This repository contains the source code for my info web site, including legal and technical details.
## Technologies
* Material for MkDocs
## Getting Started
It is recommended to use Docker for the development environment, for which the image can be built using the `dev-env.Dockerfile` in the root of the repository.
```
docker image build -t x-bwhazel-info -f dev-env.Dockerfile .
docker container run -it --rm -p 8000:8000 -v /path/to/repository:/src x-bwhazel-info bash
```
Once the container is running, the source code can be accessed in the `/src` directory.
> **NOTE:** Prior to performing any development, you will need to remove `{{secrets.azureAppInsightsKey}}` in the `src/overrides/main.html` file or replace it with a suitable Application Insights instrumentation key. If this is not done the build process will result in an error.
A Makefile wraps the MkDocs server and build functionality.
Command | Description
--- | ---
`make start` | Start the MkDocs server.
`make build` | Build the site into a `dist` directory.
`make clean` | Delete a built site.