Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ahmadnassri/docker-github-pages

jekyll & github-pages in one container
https://github.com/ahmadnassri/docker-github-pages

docker github-pages jekyll

Last synced: about 2 months ago
JSON representation

jekyll & github-pages in one container

Host: GitHub
URL: https://github.com/ahmadnassri/docker-github-pages
Owner: ahmadnassri
License: mit
Created: 2020-05-08T03:25:43.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-07-23T19:50:55.000Z (5 months ago)
Last Synced: 2024-11-02T11:22:38.551Z (about 2 months ago)
Topics: docker, github-pages, jekyll
Language: Makefile
Homepage:
Size: 123 KB
Stars: 7
Watchers: 3
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # GitHub Pages Jekyll Container

a Jekyll container with all the officially included plugins so you can run locally.

[![license][license-img]][license-url]

[![release][release-img]][release-url]

[![size][size-img]][size-url]

[![docker][docker-img]][docker-url]

[![github][github-img]][github-url]

# GitHub Pages Jekyll Container

### Included plugins:

Includes the same plugins as the ones [included with GitHub Pages][]:

-   `jekyll-coffeescript`

-   `jekyll-default-layout`

-   `jekyll-gist`

-   `jekyll-github-metadata`

-   `jekyll-optional-front-matter`

-   `jekyll-paginate`

-   `jekyll-readme-index`

-   `jekyll-titles-from-headings`

-   `jekyll-relative-links`

## Usage

create a `docker-compose.yml` with the following:

``` yaml

version: '3'

services:

  jekyll:

    image: ahmadnassri/github-pages

    volumes:

      - $PWD:/site

    ports:

      - 4000:4000

      - 35729:35729

```

> #### Volumes

>

> Map the the directory where Jekyll will read files to `/site`

  [included with GitHub Pages]: https://help.github.com/en/github/working-with-github-pages/about-github-pages-and-jekyll#plugins

----

> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •

> Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)

[license-url]: LICENSE

[license-img]: https://badgen.net/github/license/ahmadnassri/docker-github-pages

[release-url]: https://github.com/ahmadnassri/docker-github-pages/releases

[release-img]: https://badgen.net/github/release/ahmadnassri/docker-github-pages

[size-url]: https://hub.docker.com/r/ahmadnassri/github-pages

[size-img]: https://badgen.net/docker/size/ahmadnassri/github-pages

[docker-url]: https://hub.docker.com/r/ahmadnassri/github-pages

[docker-img]: https://badgen.net/badge/icon/docker%20hub?icon=docker&label

[github-url]: https://github.com/users/ahmadnassri/packages/container/package/github-pages

[github-img]: https://badgen.net/badge/icon/github%20registry?icon=github&label