docs: Drafting some ideas for the website

This commit is contained in:
Pixelastic 2016-09-01 14:20:30 +02:00
parent 22c3608292
commit b5fb54d915
7 changed files with 61 additions and 7 deletions

View File

@ -1,10 +1,13 @@
---
title: Community Boilerplate
title: Documentation
---
<div class="container">
<h1>Documentation</h1>
<p>
Mostly what is in the readme. Moving the content of the readme here, maybe automatically.
</p>
</div>

View File

@ -0,0 +1,19 @@
---
title: Examples
---
<div class="container">
<h1>Examples</h1>
<p>
Not really examples, need a better title.
</p>
<p>
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)
</p>
</div>

BIN
docs/source/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.1 KiB

View File

@ -1,13 +1,37 @@
---
title: Community Boilerplate
title: Algolia for Jekyll
---
<div class="container">
<h1>Algolia Jekyll plugin</h1>
<h1>Algolia for Jekyll</h1>
Let search into your blog or documentation
<p>Index all your blog posts or documentation into Algolia easily</p>
Add search to your static webpages
<p>[See it live] [Get Started]</p>
<p>Screenshot? Of a front-end, or a commandline indexing everything?</p>
<p>`jekyll algolia push`</p>
<div>
<h3>Host if for free</h3>
<p>Jekyll websites can already be hosted for free on GitHub pages.</p>
<p>Why not add a great search to it as well?</p>
</div>
<p>
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
</p>
<div>
Showcase. List of users with screenshots, links and details. With a final "You?"
</div>
<p>Maybe YouTube video of the jekyllconf 5mn introduction?</p>
Host it and search for free
</div>

4
scripts/docs_build Executable file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env bash
cd "$(dirname "$BASH_SOURCE")"/../docs
middleman build

4
scripts/docs_serve Executable file
View File

@ -0,0 +1,4 @@
#!/usr/bin/env bash
cd "$(dirname "$BASH_SOURCE")"/../docs
middleman serve

View File

@ -1,4 +1,4 @@
#!/usr/bin/env bash
cd "$(dirname "$BASH_SOURCE")"/..
cd "$(dirname "$BASH_SOURCE")"/../docs
guard --guardfile ./Guardfile_jekyllv2