Skip to content

Commit f1aab72

Browse files
committed
initial readme description
1 parent b199211 commit f1aab72

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,29 @@
11
# jekyll-multisites
2+
23
Jekyll Multisites allows granular control over sharing codebases, plugins, files & assets across multiple Jekyll builds.
4+
5+
### Purpose
6+
7+
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 ia system of websites.
8+
9+
### Usage
10+
11+
To spin up the example sites first download the git repository: `$ git clone git@github.com:Designaroni/jekyll-multisites.git`
12+
13+
#### Running the sites individually
14+
15+
16+
To build & serve either site run one of the following commands from the repository
17+
18+
```
19+
$ bundle exec jekyll serve --config _config_site_one.yml
20+
$ bundle exec jekyll serve --config _config_site_two.yml
21+
```
22+
23+
### Inspiration
24+
25+
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.
26+
27+
### Default Application Structure
28+
29+
... I'll get there don't worry, in the mean time shoot me a message on twitter [@designaroni](https://twitter.com/designaroni)

_config_site_one.yml

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ exclude:
2121
- Gemfile
2222
- Gemfile.lock
2323
- sites/siteTwo
24+
- README.md
2425
# any folder with and underscore is excluded by default, any folder without is included by default
2526
# included folders with the same name get merged together
2627
### config variables from plugins

_config_site_two.yml

+1
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ exclude:
2121
- Gemfile
2222
- Gemfile.lock
2323
- sites/siteOne
24+
- README.md
2425
# any folder with and underscore is excluded by default, any folder without is included by default
2526
# included folders with the same name get merged together
2627
### config variables from plugins

0 commit comments

Comments
 (0)