Giter VIP home page Giter VIP logo

knowledge-base's Introduction

knowledge-base

A static site of knowledge, tips and tricks that I've learned over the years, and wanted to gather together in a central place.

You don't need to build this repo. You can just browse the site here: https://kb.tomd.xyz

A small disclaimer

These are my unsanitised, community notes from my own learning. They are shared here for your benefit, for you to read.

No content from these pages should be taken as "best practices", advice, or scripts suitable for running production-level services. Please take time to understand what these scripts are doing to your system(s) before you execute them.

And of course, no warranty provided or liability assumed.

Building for production

Create a local directory to cache build dependencies:

sudo mkdir /usr/local/bundle

Then run a build in a ruby container:

podman run --rm \
    -v "$PWD":/usr/src/site \
    -v /usr/local/bundle:/usr/local/bundle \
    -w /usr/src/site \
    -e JEKYLL_ENV=production \
    docker.io/library/ruby:2.7 /bin/bash -c "bundle install && bundle exec jekyll build"

Developing

To build the site and serve locally:

$ bundle install
$ bundle exec jekyll serve --livereload

The site will now be available at http://localhost:4000.

Writing

How to write things in this static site.

Internal links look like this:

[maven]: {{ site.baseurl }}{% link _articles/maven.md %}

Contributing

Pull requests are welcome! If you see anything that needs improvement, please feel free to submit a PR.

Licence

Code licensed under GNU GPL v3. Content is (c) Tom and contributors.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.