Skip to content

FullByte/FullByte.github.io

README

Header

This is the source of my personal, public web page ¯\_(ツ)_/¯

Publishing my projects and notes has been great exercise for me. As longs as this works well for me I will continue doing so :) The content may appear random as it deals with basically anything I find interesting and noteworthy :)

Visit https://0xfab1.net for online view. Built with Github Actions, Github Pages, Let's Encrypt and MkDocs with Material theme.

Thanks for your interest and I appreciate your feedback and/or pull-request(s) for typos/errors in existing pages!

Stats

Type Status
Build GitHub last commit mkdocs deploy website volkswagen status
Uptime uptime day week month response
Repo license forks stars watchers
Issues issues issues-closed issues-pr issues-pr-closed

Build and Run

If you want to run the latest official docker hub build use this command and view result here: http://127.0.0.1:8000/

docker run -it --rm -p 8000:8000 0xfab1/0xfab1.net serve -a 0.0.0.0:8000

Python and Mkdocs

Clone this repository with git. To create the page you need python, and the extension for mkdocs and some mkdocs addons. View the result here: http://127.0.0.1:8080/

pip install --upgrade pip
pip install -r requirements.txt --upgrade
git clone https://github.com/FullByte/FullByte.github.io.git 0xfab1.net
cd 0xfab1.net
mkdocs serve -a localhost:8080 --dirtyreload --watch-theme -v

Docker

Alternativly use docker to run a container with all required tools + website enabled. This repository contains a dockerfile in the main folder which can be used to build a new container with this command. View the result here: http://127.0.0.1:8000/

git clone https://github.com/FullByte/FullByte.github.io.git 0xfab1.net
cd 0xfab1.net
docker build . -t yourbuild
docker run -it --rm -p 8000:8000 yourbuild serve -a 0.0.0.0:8000

Contribute

I appreciate your pull-request for typos/errors in existing pages. If you think something is generally wrong or I missed to link you/someone where appropriate, please let me know!

  • Fork the current version (e.g. with github cli): gh repo fork https://github.com/FullByte/FullByte.github.io.git)
  • Do the changes you want to make and commit the updates to your fork.
  • Test the result by building the site with your update(s).
  • If there are no errors and you are happy to share the change, open a pull request and briefly tell what you updated and why.

Thank you for your contribution :)

Contact

Mastodon

Twitter

qrcode