Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zkxs/zkxs.github.com


https://github.com/zkxs/zkxs.github.com

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# zkxs' Blog
This repo houses the source for my [blog](https://www.zkxs.dev/).

## Running locally

[Setup instructions](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll). Note that `choco install ruby` will install some fucked install, so follow the [Windows guide on the Jekyll site](https://jekyllrb.com/docs/installation/windows/).

one-time setup

```shell
# RUN AS NORMAL USER
gem install jekyll bundler
cd docs
rm Gemfile.lock
bundle install
```

To run the website

```shell
# Run locally
bundle exec jekyll serve
# Run locally, but show drafts
bundle exec jekyll serve --drafts
```

## License
- The blog source code in this repository is licensed under the [MIT License](LICENSE.txt).
- The blog content and assets (posts/images/etc.) are not provided under any license. Therefore, if you wish to fork your own blog from this you need to remove the following:
- `/docs/_drafts/*`
- `/docs/_posts/*`
- `/docs/svg/*`
- `/docs/about.md`
- `/graphs/*`

## Credits
- Uses [Graphviz](https://graphviz.org/) for graph layout and rendering - Common Public License Version 1.0
- Uses [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom) for SVG decoration - BSD-2-Clause License
- Uses [hammer.js](https://github.com/hammerjs/hammer.js) for touch support on SVG images - MIT License
- Uses the [minima](https://github.com/jekyll/minima) theme for Jekyll - MIT License