https://github.com/inlets/inlets.dev
Website and blog - inlets.dev
https://github.com/inlets/inlets.dev
Last synced: 3 months ago
JSON representation
Website and blog - inlets.dev
- Host: GitHub
- URL: https://github.com/inlets/inlets.dev
- Owner: inlets
- License: mit
- Created: 2020-08-13T06:16:49.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T13:53:26.000Z (over 1 year ago)
- Last Synced: 2024-10-19T12:49:34.822Z (over 1 year ago)
- Language: HTML
- Homepage: https://inlets.dev/
- Size: 23.8 MB
- Stars: 10
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## inlets.dev homepage
[](https://app.netlify.com/sites/inlets-dev/deploys)
## Adding a new blog post
* Create an issue and propose the topic. Wait for approval before contributing, unless you've already been asked to contribute a post.
* Create a new YAML file in `blog/_posts` - see [this example](https://github.com/alexellis/inlets.dev/blob/master/blog/_posts/2020-10-29-preparing-docker-hub-rate-limits.md) for how to set the post title and description.
* Prefix it with the date.
* Add images to `/images/` - resize all images to under 200-300KB, for a faster page loading time
* Make sure you have a cropped image for the background / title of the post, this will show up on the page roll-up at /blog/ - good sources for images are: unsplash.com and pexels.com
* Sign-off any commits you make with `git commit -s`, this is not GPG or cryptography, but [a simple declaration](https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin)
* Raise a Pull Request and fill out the whole template, including how you tested the page and the instructions.
If you use any copyrighted material such as text, code, or images, then you must credit the author.
## Usage
### Running with docker, when Ruby 2.x is not installed
For Linux:
Update the inotify settings:
```bash
echo 2048 | sudo tee /proc/sys/fs/inotify/max_user_instances
sudo sysctl -p
```
For MacOS/Linux:
Run a `yarn install` locally:
```bash
sudo npm i -g yarn
yarn install
```
Then bring the site up with:
```bash
docker-compose up --build
```
Access the site at: http://127.0.0.1:4000/
When you're finished, run: `docker-compose down`.
### Initial installation to run locally, if Ruby 2.x is installed
You will need node.js in order to install yarn:
```bash
$ npm i -g yarn
```
You may need to run `brew install/upgrade ruby` if the `bundle` command is unavailable.
If it's still unavailable run:
```bash
$ gem install bundle
```
Install Bundler, and set up your Ruby gem environment:
MacOS:
```bash
export GEM_HOME=$HOME/.gem
export PATH=$HOME/.gem/bin:$PATH
$ arch -arch x86_64 gem install bundler:2.2.13
$ arch -arch x86_64 bundle install
```
Other systems:
```bash
export GEM_HOME=$HOME/.gem
export PATH=$HOME/.gem/bin:$PATH
$ gem install bundler:2.2.13
$ bundle install
```
Install Yarn dependencies:
```bash
$ yarn install
$ yarn run tailwind init _includes/tailwind.config.js
```
### For production:
```bash
JEKYLL_ENV=production bundle exec jekyll build
```
Content will be in `_site`
### To start a preview, simply run:
```bash
$GEM_HOME/bin/bundle exec jekyll serve
```
Access the site at: http://127.0.0.1:4000/
Apple M1:
```bash
export GEM_HOME=$HOME/.gem
export PATH=$HOME/.gem/bin:$PATH
arch -arch x86_64 $GEM_HOME/bin/bundle install
arch -arch x86_64 $GEM_HOME/bin/bundle exec jekyll serve
```
## Running in Docker
If you have had some issues installing the various gems, then you can use Docker instead:
```bash
docker-compose up
```
Then access the site at http://127.0.0.1:4000