From b5fb54d91577a6a611e88b7bd706994d3498de3e Mon Sep 17 00:00:00 2001 From: Pixelastic Date: Thu, 1 Sep 2016 14:20:30 +0200 Subject: [PATCH] docs: Drafting some ideas for the website --- docs/source/documentation.html.erb | 5 ++++- docs/source/examples.html.erb | 19 ++++++++++++++++ docs/source/favicon.ico | Bin 0 -> 8342 bytes docs/source/index.html.erb | 34 ++++++++++++++++++++++++----- scripts/docs_build | 4 ++++ scripts/docs_serve | 4 ++++ scripts/watch_v2 | 2 +- 7 files changed, 61 insertions(+), 7 deletions(-) create mode 100644 docs/source/examples.html.erb create mode 100644 docs/source/favicon.ico create mode 100755 scripts/docs_build create mode 100755 scripts/docs_serve diff --git a/docs/source/documentation.html.erb b/docs/source/documentation.html.erb index 2c524ed..8fddf8d 100644 --- a/docs/source/documentation.html.erb +++ b/docs/source/documentation.html.erb @@ -1,10 +1,13 @@ --- -title: Community Boilerplate +title: Documentation ---

Documentation

+

+ Mostly what is in the readme. Moving the content of the readme here, maybe automatically. +

diff --git a/docs/source/examples.html.erb b/docs/source/examples.html.erb new file mode 100644 index 0000000..635b7de --- /dev/null +++ b/docs/source/examples.html.erb @@ -0,0 +1,19 @@ +--- +title: Examples +--- + + + +
+

Examples

+

+ Not really examples, need a better title. +

+ +

+ Explaining how to build a front-end with the data. Using the fork of the Hyde theme as an example. + The theme uses an instantsearch-like experience, updating the whole page on search. + We might also want to provide an autocomplete experience, with a dropdown similar to DocSearch (DocSearch might just work as-is) +

+
+ diff --git a/docs/source/favicon.ico b/docs/source/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..494adaaab25d71a6b9888df7ae2ea1a378ca65df GIT binary patch literal 8342 zcmd7W4Nw$S902gg&`32lP&pJe25HSS18O4!3?Fe=gisO_qjhpe44;~q9Hjx}$VE2J zIO?RO12JGqU>`Fokw}cx;h2S11c_FDgqT*w5E5e;$NhW%x4gT(W%s_kJ8pIN&)&X! z@3;SX``+6l#E<@qm`CU_jOfD%2_}R*LiY%|XVD!$$8Gol7Cd^mbEf~oXQO8hJ{atu z=h24TP&ryNqHY~}KJE^nyUCZ$Vyh9|LuNKI$@tH6V~#5`=E1vFtDtGun^3p43@Y-H&DXe< zM|YaVR-yhNI=9vXp9^@KJm#l844thXfoWm_q+9>lQ?R}$Rn{#wC%Kqsv9){+f$9bV z>I9sdaJ|LWTvlykPXD;{D`TEJ-3@hH%3z~z8EoHB1V`IGfr$wt7>(nw?X_I1@9}$0 zQ|FuehO=fXYYBlbE)pb}{R|>bF20A2_Al>xGNqpKC+#-;IAk zr;eF&9o?>&m8{!#$Xl@;%o%P+n)k{&cn&v~EM?`6cN|nK=Zslwtq|qamK7~0IuElx zyYiU`MF%&Z?miC2@o~sW4pl5`W!Ba5a#m|3E33}Z2kcqVF?jVdTs+&y>$MrNzu>0y z?D6|bQ|DRwvy7R)Z&f&H#rm(0jsWJ3wlhYi`)Vysze{WXntIPT0`S)Qm~by>ZMFNhTUM}aO2K5Sh?ngcdW`t zbBgD-to$bjC3C|e2<{F zs=0RaTKM)@8|~}Cfa5A|n9q|(+n}Xs7kv5IJ{bDzclJ5;nU$dzce)zhBt<`Yu!?l_C zy7cdx$t$<=D1HWCjE;of*`079q{pWD6-_)`y6_X5_Xhv`4G!#iThZ%ItDJdtRE$Gr zX%6MiJz@2f*^^dxo4sLmm)VdxeNry^mP! znfng-o>j@*MSo-QwY+jGkK+EUO`I_;;{dlf8pY=6ezu%3tHJ}0;Jcxt-*KiKz%_tj zLICg5r^0*W*Q6-hfeOsc)E`V*R{5-ahwm ipV><*VE+Ee`{DP;@0Z^{&j(EA2Y9}C{&+rx{QeJ!d4Mhe literal 0 HcmV?d00001 diff --git a/docs/source/index.html.erb b/docs/source/index.html.erb index ecf108f..6c64d53 100644 --- a/docs/source/index.html.erb +++ b/docs/source/index.html.erb @@ -1,13 +1,37 @@ --- -title: Community Boilerplate +title: Algolia for Jekyll ---
-

Algolia Jekyll plugin

+

Algolia for Jekyll

- Let search into your blog or documentation +

Index all your blog posts or documentation into Algolia easily

- Add search to your static webpages +

[See it live] [Get Started]

+ +

Screenshot? Of a front-end, or a commandline indexing everything?

+ +

`jekyll algolia push`

+ +
+

Host if for free

+

Jekyll websites can already be hosted for free on GitHub pages.

+

Why not add a great search to it as well?

+
+ +

+ Features + - Open-Source + - Index pages, posts, collections + - Works well with other plugins + - Hooks to fine-tune what to index + - Compatible Jekyll 2.5 and Jekyll 3 +

+ +
+ Showcase. List of users with screenshots, links and details. With a final "You?" +
+ +

Maybe YouTube video of the jekyllconf 5mn introduction?

- Host it and search for free
diff --git a/scripts/docs_build b/scripts/docs_build new file mode 100755 index 0000000..2242ead --- /dev/null +++ b/scripts/docs_build @@ -0,0 +1,4 @@ +#!/usr/bin/env bash +cd "$(dirname "$BASH_SOURCE")"/../docs + +middleman build diff --git a/scripts/docs_serve b/scripts/docs_serve new file mode 100755 index 0000000..b76c7b2 --- /dev/null +++ b/scripts/docs_serve @@ -0,0 +1,4 @@ +#!/usr/bin/env bash +cd "$(dirname "$BASH_SOURCE")"/../docs + +middleman serve diff --git a/scripts/watch_v2 b/scripts/watch_v2 index fa573d3..130a645 100755 --- a/scripts/watch_v2 +++ b/scripts/watch_v2 @@ -1,4 +1,4 @@ #!/usr/bin/env bash -cd "$(dirname "$BASH_SOURCE")"/.. +cd "$(dirname "$BASH_SOURCE")"/../docs guard --guardfile ./Guardfile_jekyllv2