Skip to content

Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #4

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fa0ae2
Update README.md
Designaroni Jul 11, 2020
b88e473
Update README.md
Designaroni Jul 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,36 @@
# jekyll-multisites

Jekyll Multisites allows granular control over sharing codebases, plugins, files & assets across multiple Jekyll builds.
Jekyll Multisites allows control for sharing files & directories between multiple Jekyll sites. This allows a developer to share project assets, images, css, scripts etc... across sites.

### Inspiration

This project came out of a need to share code & modular web components across a system of sites, Branding assets, shared call to action banners, modules of custom html, css & javscript, shared vendor assets plugins & gems.

### Purpose

The purpose of `jekyll-multisites` is to demonstrate the capabilities of Jekyll as a tool for sharing assets across multiple builds. HTML, CSS, JavaScript, image assets, plugins & gems can be shared as the source files for a system of websites.
The purpose of `jekyll-multisites` is to demonstrate the capabilities of Jekyll as a tool for sharing assets across multiple builds. HTML, CSS, JavaScript, image assets, plugins & gems can be shared as the source files for a system of static JAMstack websites.

### Usage

To spin up the example sites first download the git repository: `$ git clone git@github.com:Designaroni/jekyll-multisites.git`

#### Running the sites individually


To build & serve either site run one of the following commands from the repository
Install Bundler if you don't already have it:

```
$ bundle exec jekyll serve --config _config_site_one.yml
$ bundle exec jekyll serve --config _config_site_two.yml
$ gem install bundler
```

### Inspiration
Intall the projects needed gems:

Inspiration for this project came out of a need to share modular web components across a system of sites, Branding assets, shared call to action banners, modules of custom html, css & javscript & shared vendor assets.
```
$ bundle install
```

### Default Application Structure
To build & serve either site run one of the following commands from the repository directory:

... I'll get there don't worry, in the mean time shoot me a message on twitter [@designaroni](https://twitter.com/designaroni)
```
$ bundle exec jekyll serve --config _config_site_one.yml
$ bundle exec jekyll serve --config _config_site_two.yml
```