From d58c4191779d320e032db246457a0cfd4dc72792 Mon Sep 17 00:00:00 2001 From: Abhishek Arya Date: Tue, 6 Aug 2019 13:29:19 -0700 Subject: [PATCH] Add jekyll generator for docs. (#2660) * Add jekyll generator for docs. * Add content for index.md --- docs/.gitignore | 5 + docs/404.html | 23 +++++ docs/Gemfile | 2 + docs/Gemfile.lock | 248 ++++++++++++++++++++++++++++++++++++++++++++++ docs/README.md | 14 +++ docs/_config.yml | 40 ++++++++ docs/favicon.ico | Bin 0 -> 15086 bytes docs/index.md | 44 ++++++++ oss-fuzz.iml | 9 ++ 9 files changed, 385 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/404.html create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/README.md create mode 100644 docs/_config.yml create mode 100644 docs/favicon.ico create mode 100644 docs/index.md create mode 100644 oss-fuzz.iml diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..585ecc409 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,5 @@ +_site +.bundle +.sass-cache +.jekyll-metadata +vendor diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 000000000..91053a628 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,23 @@ +--- +layout: default +--- + + + +
+

404

+ +

Page not found :(

+
diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..7434b39d2 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,2 @@ +source "https://rubygems.org" +gem 'github-pages', group: :jekyll_plugins diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 000000000..38ac78e3d --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,248 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.10) + i18n (~> 0.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.5.2) + public_suffix (>= 2.0.2, < 4.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.4) + dnsruby (1.61.2) + addressable (~> 2.5) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + ethon (0.12.0) + ffi (>= 1.3.0) + eventmachine (1.2.7) + execjs (2.7.0) + faraday (0.15.4) + multipart-post (>= 1.2, < 3) + ffi (1.10.0) + forwardable-extended (2.6.0) + gemoji (3.0.0) + github-pages (193) + activesupport (= 4.2.10) + github-pages-health-check (= 1.8.1) + jekyll (= 3.7.4) + jekyll-avatar (= 0.6.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.5) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.11.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.9.4) + jekyll-mentions (= 1.4.1) + jekyll-optional-front-matter (= 0.3.0) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.2.0) + jekyll-redirect-from (= 0.14.0) + jekyll-relative-links (= 0.5.3) + jekyll-remote-theme (= 0.3.1) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.5.0) + jekyll-sitemap (= 1.2.0) + jekyll-swiss (= 0.4.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.1) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.3) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.1) + jemoji (= 0.10.1) + kramdown (= 1.17.0) + liquid (= 4.0.0) + listen (= 3.1.5) + mercenary (~> 0.3) + minima (= 2.5.0) + nokogiri (>= 1.8.2, < 2.0) + rouge (= 2.2.1) + terminal-table (~> 1.4) + github-pages-health-check (1.8.1) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (~> 2.0) + typhoeus (~> 1.3) + html-pipeline (2.10.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.7.4) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (~> 1.14) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.6.0) + jekyll (~> 3.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.2.0) + commonmarker (~> 0.14) + jekyll (>= 3.0, < 4.0) + jekyll-commonmark-ghpages (0.1.5) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1) + rouge (~> 2) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.11.0) + jekyll (~> 3.3) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.9.4) + jekyll (~> 3.1) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.4.1) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-optional-front-matter (0.3.0) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.2.0) + jekyll (~> 3.0) + jekyll-redirect-from (0.14.0) + jekyll (~> 3.3) + jekyll-relative-links (0.5.3) + jekyll (~> 3.3) + jekyll-remote-theme (0.3.1) + jekyll (~> 3.5) + rubyzip (>= 1.2.1, < 3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.5.0) + jekyll (~> 3.3) + jekyll-sitemap (1.2.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.3) + jekyll (~> 3.5) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.1) + jekyll (~> 3.3) + jekyll-watch (2.1.2) + listen (~> 3.0) + jemoji (0.10.1) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (~> 3.0) + kramdown (1.17.0) + liquid (4.0.0) + listen (3.1.5) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + ruby_dep (~> 1.2) + mercenary (0.3.6) + mini_portile2 (2.4.0) + minima (2.5.0) + jekyll (~> 3.5) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.11.3) + multipart-post (2.0.0) + nokogiri (1.10.1) + mini_portile2 (~> 2.4.0) + octokit (4.13.0) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (2.0.5) + rb-fsevent (0.10.3) + rb-inotify (0.10.0) + ffi (~> 1.0) + rouge (2.2.1) + ruby-enum (0.7.2) + i18n + ruby_dep (1.5.0) + rubyzip (1.2.2) + safe_yaml (1.0.4) + sass (3.7.3) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.1) + addressable (>= 2.3.5, < 2.6) + faraday (~> 0.8, < 1.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (1.3.1) + ethon (>= 0.9.0) + tzinfo (1.2.5) + thread_safe (~> 0.1) + unicode-display_width (1.4.1) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + +BUNDLED WITH + 1.15.1 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..edfbdfff4 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,14 @@ +# Prerequisites +```bash +sudo apt install ruby bundler +bundle install --path vendor/bundle +``` + +# Serving locally +```bash +bundle exec jekyll serve +``` + +# Theme documentation +We are using the [just the docs](https://pmarsceill.github.io/just-the-docs/) +theme. diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..df2c8fb29 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,40 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. + +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. +title: OSS-Fuzz +description: Documentation for OSS-Fuzz +baseurl: "/oss-fuzz" # the subpath of your site, e.g. /blog +url: "" # the base hostname & protocol for your site, e.g. http://example.com + +# Build settings +markdown: kramdown +remote_theme: pmarsceill/just-the-docs +search_enabled: true + +ga_tracking: UA-88024544-5 + +aux_links: + "OSS-Fuzz on GitHub": + - https://github.com/google/oss-fuzz + +# Exclude from processing. +exclude: + - Gemfile + - Gemfile.lock + - node_modules + - vendor/bundle/ + - vendor/cache/ + - vendor/gems/ + - vendor/ruby/ diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..46a19509f373510556c04b529d8a3423f894ff9c GIT binary patch literal 15086 zcmeI2du$X%9LMLlw)7BbO9igGKnf88^U~lhEN3B@X11 z7=zwnlwQaM@GcC|@UMjFwvkJOMq3toZ?prooQp|a(01-uGVp%PMcqGRO}4nBu{ z;J_A`Q(gT;eQoWR&!hh*IItJqfl~mLj4a?t<=m{Ru730q%Kw3`%3AhwJgJAvKS$B+TGPz+D=j^K0_B=xv2kNLSKVquZK+MQ?Ur$zYyfRor#w5w= z@X&c71GIyIpsePZMi>p6pHiZUCzSun2n6;e&3mAEJl9+vwBPc!%it-{oFu=_D(QCB zw&s7W1CPO}P>dbw@0qX|wu7GMKj29?86uDo+EBY%zgQ1euK=whnv2_EI>f=dCS}Td z4(d3c4L^h0^|Fz?dthK$Src`xQUA^Wtz+B3u0uB6N8V?kHR&kGWyc`uU74j#uMPXr zc?Ej2W}Ho(-ZjX!?N0Zg*P5sOM;s3tV5?A5WdC+ufGm@eAnX@`tefBYXVi z|L=hO+w1f0bFJ-5K>mLgKJ{Gy|J#ku1CZo;%e&o(Z|)JT9l?E`Akjy31!fZb#=lkiAPlzM4(X=E>LP^YZ;%qP5SK$(3qs zE{DFLIXaiFz1EJN{3(}&?FSpn|LgcG=GhI_XZ+G1(HQ~qf5j;I=5p1u67u=K-qEgx zkHP!?sXBPuF)zYdpm|C%5M=j8$Y!r%yxE|bFQ^Pa@oxAYRHyED5)>zwgI6@aDQ4C4 zqZn3Y6w@vS#kkg14g-toJP95F&BdDM@`+;iW>73ITXlcBE3!irBE|H#korU2B1eEV zGb8()Hm5T&$4NFsoYr!aph__+3kj}|N;aB`PE!)?GL;cM@cvX%;q<8U!Tt(ohx2}> zK@Q~5O>hHb_9<+%LtZH12!taLjzA$Jz)|k%1s6k*_bk*76>Bdk z-$+*93)es&I8?D`&lKBC1N*+TmE(ml90INLvM)_P(#fzE^i5_bEQRwR3RKx+qS$aE ztb%N@VF&p$Am@9YY=Tl43wn?K3%u|1zmxX}41s)m2{f5gqFg-}^q#11If@Pa(0k+; za2@E~E+c6>w6CW9R=<4+cRzGL*2AsPAByRRV&-}98~E9rEnn{t%Rui4rlw}4+OCG_ z&<<`p^BrrS_dU223iYY`Xg-^LLGxBnJ{FHJm;Kj+_IdKz>vvuEVlZe(f=U9#ptfey z`;hW|;_)|S|4rSnU47F2v*xLwwo5OxKOBGiJcRyJ__G{7zX#{rBhi0am_u!xmTi8| zm8bppIZzUhzpeRSG1(f>w@Uj=22B;$JqwEWsInkA5pDN(fm}B0+8$UAVPIhVf<=(+ zTe9t!zIRQ70bnAL)K;Ei;K5Mr{+eu=1fPLBhSnbGLr@P^6u0Ud$5Qwj?u28&3?BT6 z`oVX(R800Rsr?o&+qb|17z!p9yGTW3ul7L~!+MwwaVS<)R&}T@)#=@19YUV=P2F*; z_HZ?yUI~n2FY8lP*s1?A=pAMmTmU>XZ=jYEjfuuaV`T5U#!h3XvDBCrBN`LkOKizV z6-T#%`sKH$u6Kx+;T(vTl?_)v^j@d%@j?-|?^L&4osAi=O$hupBfO_?36(Z$?jZjOLm`rJMpPt8WYLI)fbR9<77X zAki3V&ehx-q`X&0bA1aGBKj`S2Hv^~Iln#KU>{OFBZZXp>L${41x-TxjS0v9pwET= zb8sxY&z9eL=syR?>`3#UN+#M*yD?{L4V#jltQCuB&&$uxg5+z@tq@ThGzQ*=pzFQ0 z<0s0r!XU6Rf`etCJxHq;Bvq_959**8si4qJ@D=#QZq|DD&3n<1eL?S2;hlQ{eWd8=32KttAI7MT8IouCJy4jGvQH_ULFbveM zP{I)iM<5)5f87Wi_|FiNZA$W|{L^TY{tny~by^doo%};-6ls!eq6*Sh{&f^hrIkIJ zCfOqEO}!oFBNHe6D;hO7BnSY?Ofq>acE|b8Ewi}OL0rM=>?HaBATw_drhQZOb()4$ a{aq%}N+ja!k2uLuq|RLa + + + + + + + + \ No newline at end of file