Skip to content

Commit 0ddafaf

Browse files
MahmoudzMahmoudz
committed
add docs/ to generate github page
1 parent 8603110 commit 0ddafaf

224 files changed

Lines changed: 23095 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_site/
2+
.sass-cache/
3+
.jekyll-metadata
4+
_pdf
5+
.idea/
6+
.DS_Store

‎docs/404.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Page Not Found"
3+
search: exclude
4+
---
5+
6+
Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct.

‎docs/Dockerfile‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
FROM ruby:2.1
2+
MAINTAINER mrafayaleem@gmail.com
3+
4+
RUN apt-get clean \
5+
&& mv /var/lib/apt/lists /var/lib/apt/lists.broke \
6+
&& mkdir -p /var/lib/apt/lists/partial
7+
8+
RUN apt-get update
9+
10+
RUN apt-get install -y \
11+
node \
12+
python-pygments \
13+
&& apt-get clean \
14+
&& rm -rf /var/lib/apt/lists/
15+
16+
WORKDIR /tmp
17+
ADD Gemfile /tmp/
18+
ADD Gemfile.lock /tmp/
19+
RUN bundle install
20+
21+
VOLUME /src
22+
EXPOSE 4000
23+
24+
WORKDIR /src
25+
ENTRYPOINT ["jekyll"]
26+

‎docs/Gemfile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
source "https://rubygems.org"
2+
3+
gem 'github-pages', group: :jekyll_plugins

‎docs/Gemfile.lock‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (4.2.7)
5+
i18n (~> 0.7)
6+
json (~> 1.7, >= 1.7.7)
7+
minitest (~> 5.1)
8+
thread_safe (~> 0.3, >= 0.3.4)
9+
tzinfo (~> 1.1)
10+
addressable (2.5.0)
11+
public_suffix (~> 2.0, >= 2.0.2)
12+
coffee-script (2.4.1)
13+
coffee-script-source
14+
execjs
15+
coffee-script-source (1.12.2)
16+
colorator (1.1.0)
17+
ethon (0.10.1)
18+
ffi (>= 1.3.0)
19+
execjs (2.7.0)
20+
faraday (0.11.0)
21+
multipart-post (>= 1.2, < 3)
22+
ffi (1.9.17)
23+
forwardable-extended (2.6.0)
24+
gemoji (2.1.0)
25+
github-pages (117)
26+
activesupport (= 4.2.7)
27+
github-pages-health-check (= 1.3.0)
28+
jekyll (= 3.3.1)
29+
jekyll-avatar (= 0.4.2)
30+
jekyll-coffeescript (= 1.0.1)
31+
jekyll-default-layout (= 0.1.4)
32+
jekyll-feed (= 0.8.0)
33+
jekyll-gist (= 1.4.0)
34+
jekyll-github-metadata (= 2.3.1)
35+
jekyll-mentions (= 1.2.0)
36+
jekyll-optional-front-matter (= 0.1.2)
37+
jekyll-paginate (= 1.1.0)
38+
jekyll-readme-index (= 0.0.3)
39+
jekyll-redirect-from (= 0.11.0)
40+
jekyll-relative-links (= 0.2.1)
41+
jekyll-sass-converter (= 1.5.0)
42+
jekyll-seo-tag (= 2.1.0)
43+
jekyll-sitemap (= 0.12.0)
44+
jekyll-swiss (= 0.4.0)
45+
jekyll-theme-architect (= 0.0.3)
46+
jekyll-theme-cayman (= 0.0.3)
47+
jekyll-theme-dinky (= 0.0.3)
48+
jekyll-theme-hacker (= 0.0.3)
49+
jekyll-theme-leap-day (= 0.0.3)
50+
jekyll-theme-merlot (= 0.0.3)
51+
jekyll-theme-midnight (= 0.0.3)
52+
jekyll-theme-minimal (= 0.0.3)
53+
jekyll-theme-modernist (= 0.0.3)
54+
jekyll-theme-primer (= 0.1.7)
55+
jekyll-theme-slate (= 0.0.3)
56+
jekyll-theme-tactile (= 0.0.3)
57+
jekyll-theme-time-machine (= 0.0.3)
58+
jekyll-titles-from-headings (= 0.1.4)
59+
jemoji (= 0.7.0)
60+
kramdown (= 1.11.1)
61+
liquid (= 3.0.6)
62+
listen (= 3.0.6)
63+
mercenary (~> 0.3)
64+
minima (= 2.0.0)
65+
nokogiri (= 1.6.8.1)
66+
rouge (= 1.11.1)
67+
terminal-table (~> 1.4)
68+
github-pages-health-check (1.3.0)
69+
addressable (~> 2.3)
70+
net-dns (~> 0.8)
71+
octokit (~> 4.0)
72+
public_suffix (~> 2.0)
73+
typhoeus (~> 0.7)
74+
html-pipeline (2.5.0)
75+
activesupport (>= 2)
76+
nokogiri (>= 1.4)
77+
i18n (0.7.0)
78+
jekyll (3.3.1)
79+
addressable (~> 2.4)
80+
colorator (~> 1.0)
81+
jekyll-sass-converter (~> 1.0)
82+
jekyll-watch (~> 1.1)
83+
kramdown (~> 1.3)
84+
liquid (~> 3.0)
85+
mercenary (~> 0.3.3)
86+
pathutil (~> 0.9)
87+
rouge (~> 1.7)
88+
safe_yaml (~> 1.0)
89+
jekyll-avatar (0.4.2)
90+
jekyll (~> 3.0)
91+
jekyll-coffeescript (1.0.1)
92+
coffee-script (~> 2.2)
93+
jekyll-default-layout (0.1.4)
94+
jekyll (~> 3.0)
95+
jekyll-feed (0.8.0)
96+
jekyll (~> 3.3)
97+
jekyll-gist (1.4.0)
98+
octokit (~> 4.2)
99+
jekyll-github-metadata (2.3.1)
100+
jekyll (~> 3.1)
101+
octokit (~> 4.0, != 4.4.0)
102+
jekyll-mentions (1.2.0)
103+
activesupport (~> 4.0)
104+
html-pipeline (~> 2.3)
105+
jekyll (~> 3.0)
106+
jekyll-optional-front-matter (0.1.2)
107+
jekyll (~> 3.0)
108+
jekyll-paginate (1.1.0)
109+
jekyll-readme-index (0.0.3)
110+
jekyll (~> 3.0)
111+
jekyll-redirect-from (0.11.0)
112+
jekyll (>= 2.0)
113+
jekyll-relative-links (0.2.1)
114+
jekyll (~> 3.3)
115+
jekyll-sass-converter (1.5.0)
116+
sass (~> 3.4)
117+
jekyll-seo-tag (2.1.0)
118+
jekyll (~> 3.3)
119+
jekyll-sitemap (0.12.0)
120+
jekyll (~> 3.3)
121+
jekyll-swiss (0.4.0)
122+
jekyll-theme-architect (0.0.3)
123+
jekyll (~> 3.3)
124+
jekyll-theme-cayman (0.0.3)
125+
jekyll (~> 3.3)
126+
jekyll-theme-dinky (0.0.3)
127+
jekyll (~> 3.3)
128+
jekyll-theme-hacker (0.0.3)
129+
jekyll (~> 3.3)
130+
jekyll-theme-leap-day (0.0.3)
131+
jekyll (~> 3.3)
132+
jekyll-theme-merlot (0.0.3)
133+
jekyll (~> 3.3)
134+
jekyll-theme-midnight (0.0.3)
135+
jekyll (~> 3.3)
136+
jekyll-theme-minimal (0.0.3)
137+
jekyll (~> 3.3)
138+
jekyll-theme-modernist (0.0.3)
139+
jekyll (~> 3.3)
140+
jekyll-theme-primer (0.1.7)
141+
jekyll (~> 3.3)
142+
jekyll-theme-slate (0.0.3)
143+
jekyll (~> 3.3)
144+
jekyll-theme-tactile (0.0.3)
145+
jekyll (~> 3.3)
146+
jekyll-theme-time-machine (0.0.3)
147+
jekyll (~> 3.3)
148+
jekyll-titles-from-headings (0.1.4)
149+
jekyll (~> 3.3)
150+
jekyll-watch (1.5.0)
151+
listen (~> 3.0, < 3.1)
152+
jemoji (0.7.0)
153+
activesupport (~> 4.0)
154+
gemoji (~> 2.0)
155+
html-pipeline (~> 2.2)
156+
jekyll (>= 3.0)
157+
json (1.8.6)
158+
kramdown (1.11.1)
159+
liquid (3.0.6)
160+
listen (3.0.6)
161+
rb-fsevent (>= 0.9.3)
162+
rb-inotify (>= 0.9.7)
163+
mercenary (0.3.6)
164+
mini_portile2 (2.1.0)
165+
minima (2.0.0)
166+
minitest (5.10.1)
167+
multipart-post (2.0.0)
168+
net-dns (0.8.0)
169+
nokogiri (1.6.8.1)
170+
mini_portile2 (~> 2.1.0)
171+
octokit (4.6.2)
172+
sawyer (~> 0.8.0, >= 0.5.3)
173+
pathutil (0.14.0)
174+
forwardable-extended (~> 2.6)
175+
public_suffix (2.0.5)
176+
rb-fsevent (0.9.8)
177+
rb-inotify (0.9.8)
178+
ffi (>= 0.5.0)
179+
rouge (1.11.1)
180+
safe_yaml (1.0.4)
181+
sass (3.4.23)
182+
sawyer (0.8.1)
183+
addressable (>= 2.3.5, < 2.6)
184+
faraday (~> 0.8, < 1.0)
185+
terminal-table (1.7.3)
186+
unicode-display_width (~> 1.1.1)
187+
thread_safe (0.3.5)
188+
typhoeus (0.8.0)
189+
ethon (>= 0.8.0)
190+
tzinfo (1.2.2)
191+
thread_safe (~> 0.1)
192+
unicode-display_width (1.1.3)
193+
194+
PLATFORMS
195+
ruby
196+
197+
DEPENDENCIES
198+
github-pages
199+
200+
BUNDLED WITH
201+
1.14.3

‎docs/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Laradock Documentation
2+
3+
You can read the documentation here [laradock.github.io/documentation](https://laradock.github.io/documentation/).
4+
5+
Or visit the Laradock [Repository](https://github.com/laradock/laradock).
6+
7+
8+
9+
10+
## How to contribute?
11+
12+
The Laradock documentation is built using [Jekyll](https://jekyllrb.com) and the theme [Jekyll Doc Theme 6.0](https://github.com/tomjohnson1492/documentation-theme-jekyll). And it's hosted on Github [Pages](https://pages.github.com).
13+
14+
For details on where to write your docs and how to modify the theme, please check the theme [documentation](http://idratherbewriting.com/documentation-theme-jekyll/index.html).
15+
16+
#### Run it locally on your machine:
17+
18+
1. Clone this repository.
19+
2. Serve the files with `jekyll serve --watch`.
20+
3. Visit the server address from your browser.
21+
22+
More details in the [Jekyll Doc Theme 6.0 Documentation](http://idratherbewriting.com/documentation-theme-jekyll/mydoc_install_jekyll_on_mac.html).

‎docs/_config.yml‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
repository: tomjohnson1492/documentation-theme-jekyll
2+
3+
output: web
4+
# this property is useful for conditional filtering of content that is separate from the PDF.
5+
6+
topnav_title: Jekyll Documentation Theme
7+
# this appears on the top navigation bar next to the home button
8+
9+
site_title: Jekyll theme for documentation
10+
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
11+
12+
company_name: Your company
13+
# this appears in the footer
14+
15+
github_editme_path: tomjohnson1492/documentation-theme-jekyll/blob/gh-pages/
16+
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
17+
18+
disqus_shortname: idrbwjekyll
19+
# if you're using disqus for comments, add the shortname here. if not, leave this value blank.
20+
21+
host: 127.0.0.1
22+
# the preview server used. Leave as is.
23+
24+
port: 4000
25+
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
26+
27+
exclude:
28+
- .idea/
29+
- .gitignore
30+
# these are the files and directories that jekyll will exclude from the build
31+
32+
feedback_subject_line: Jekyll documentation theme
33+
34+
feedback_email: tomjohnson1492@gmail.com
35+
# used as a contact email for the Feedback link in the top navigation bar
36+
37+
# feedback_disable: true
38+
# if you uncomment the previous line, the Feedback link gets removed
39+
40+
# feedback_text: "Need help?"
41+
# if you uncomment the previous line, it changes the Feedback text
42+
43+
# feedback_link: "http://helpy.io/"
44+
# if you uncomment the previous line, it changes where the feedback link points to
45+
46+
highlighter: rouge
47+
# library used for syntax highlighting
48+
49+
markdown: kramdown
50+
kramdown:
51+
input: GFM
52+
auto_ids: true
53+
hard_wrap: false
54+
syntax_highlighter: rouge
55+
56+
# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways
57+
58+
collections:
59+
tooltips:
60+
output: false
61+
# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true
62+
63+
defaults:
64+
-
65+
scope:
66+
path: ""
67+
type: "pages"
68+
values:
69+
layout: "page"
70+
comments: true
71+
search: true
72+
sidebar: home_sidebar
73+
-
74+
scope:
75+
path: ""
76+
type: "tooltips"
77+
values:
78+
layout: "page"
79+
comments: true
80+
search: true
81+
tooltip: true
82+
83+
-
84+
scope:
85+
path: ""
86+
type: "posts"
87+
values:
88+
layout: "post"
89+
comments: true
90+
search: true
91+
sidebar: home_sidebar
92+
93+
# these are defaults used for the frontmatter for these file types
94+
95+
sidebars:
96+
- home_sidebar
97+
- mydoc_sidebar
98+
- product1_sidebar
99+
- product2_sidebar
100+
- other
101+
102+
description: "Intended as a documentation theme based on Jekyll for technical writers documenting software and other technical products, this theme has all the elements you would need to handle multiple products with both multi-level sidebar navigation, tags, and other documentation features."
103+
# the description is used in the feed.xml file
104+
105+
# needed for sitemap.xml file only
106+
url: http://idratherbewriting.com

‎docs/_data/alerts.yml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
tip: '<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>'
2+
note: '<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>'
3+
important: '<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>'
4+
warning: '<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>'
5+
end: '</div>'
6+
7+
callout_danger: '<div class="bs-callout bs-callout-danger">'
8+
callout_default: '<div class="bs-callout bs-callout-default">'
9+
callout_primary: '<div class="bs-callout bs-callout-primary">'
10+
callout_success: '<div class="bs-callout bs-callout-success">'
11+
callout_info: '<div class="bs-callout bs-callout-info">'
12+
callout_warning: '<div class="bs-callout bs-callout-warning">'
13+
14+
hr_faded: '<hr class="faded"/>'
15+
hr_shaded: '<hr class="shaded"/>'

0 commit comments

Comments
 (0)