diff --git a/app.py b/app.py
index 2772677..8192c07 100644
--- a/app.py
+++ b/app.py
@@ -55,6 +55,10 @@ def about():
def developers():
return render_template("developers.html")
+@app.route("/docs")
+def docs():
+ return render_template("docs.html")
+
@app.errorhandler(404)
def error404(error):
return render_template("error404.html"), 404
diff --git a/static/sass/_logo.sass b/static/sass/_logo.sass
new file mode 100644
index 0000000..ea22411
--- /dev/null
+++ b/static/sass/_logo.sass
@@ -0,0 +1,18 @@
+a#logo
+ letter-spacing: 0.3em
+ text-decoration: none
+
+ div#logo
+ font-size: 400%
+ padding-bottom: 0.2em
+ text-align: center
+
+ #logo-bit
+ color: $baseColor1
+
+ #logo-angle
+ color: $baseColor3
+
+ #logo-shift
+ color: $baseColor2
+ font-style: italic
diff --git a/static/sass/docs.sass b/static/sass/docs.sass
new file mode 100644
index 0000000..6d23e32
--- /dev/null
+++ b/static/sass/docs.sass
@@ -0,0 +1,40 @@
+@import variables
+@import logo
+
+h1
+ color: $baseColor1
+
+ span
+ color: $baseColor2
+
+h2, h3
+ color: $baseColor2 * 0.8
+
+p
+ line-height: 1.8em
+
+ul
+ list-style: none
+ margin-bottom: 2%
+
+ li
+ margin-bottom: 2%
+
+span
+ code
+ background-color: $baseColor3 * 1.2
+ font-family: monospace
+ padding: 5px
+
+ string
+ color: $baseColor1
+ font-family: monospace
+ font-size: 1.1em
+
+ title
+ color: $baseColor1
+ font-weight: bold
+
+li#sec3 span#gasp
+ color: $baseColor2 * 0.8
+ font-style: italic
diff --git a/static/sass/index.sass b/static/sass/index.sass
index 2c31167..550a8c6 100644
--- a/static/sass/index.sass
+++ b/static/sass/index.sass
@@ -4,6 +4,7 @@
@import mixins
@import variables
+@import logo
$minSearchFieldsWidth: 490px
$codeWidth: 700px
@@ -84,25 +85,6 @@ div#search-field
top: 0
width: 40%
- a#title
- letter-spacing: 0.3em
- text-decoration: none
-
- div#title
- font-size: 400%
- padding-bottom: 0.2em
- text-align: center
-
- #title-bit
- color: $baseColor1
-
- #title-angle
- color: $baseColor3
-
- #title-shift
- color: $baseColor2
- font-style: italic
-
form#search-bar
min-width: $minSearchFieldsWidth
@@ -143,7 +125,7 @@ div#search-field
position: absolute
width: 100%
- #title
+ #logo
position: absolute
top: -1%
left: 1%
diff --git a/templates/docs.html b/templates/docs.html
new file mode 100644
index 0000000..0ac9bc5
--- /dev/null
+++ b/templates/docs.html
@@ -0,0 +1,126 @@
+= extends "layout.html"
+
+= block title
+ docs
+= endblock
+
+= block head
+ {{ assets.tag("docs.css") }}
+= endblock
+
+= block body
+
+
+ bitshift is a search-engine optimized for source code: beyond supporting searches with the full range of ASCII + symbols, the engine understands code, allowing users to query for metadata, like time of creation/last + modification, programming language, and even symbols like function names and variables. Basic use boils down to + general and advanced searches. + +
+ To perform a "general search," simply place your cursor in the search bar on our home page and begin + entering text; when you stop typing for a short period of time, we'll automatically execute the query for you. + As you scroll down the results page, new codelets will be seamlessly downloaded from our server and + appended to the end. +
++ General searches, though, are limited. To allow users to make the best of our engine, we created an advanced + search form that allows the creation of complex queries with the following specifiers: + +
+ Each of the search fields allows for numerous values; just separate them with spaces. If you'd like + to search for a multi-word, space-delimited string, on the other hand, enclose it in double quotes. + + A query for foo bar will search for occurrences of both "foo" and "bar", while "foo bar" + will search for occurrences of "foo bar". +
++ Search groups facilitate even more robust queries: they're like a bunch of individual searches + grouped into one. A user searching for occurrenes of symbol "curses" in the + language "Python", and "ncurses" in "C", won't get away with: symbols: "curses ncurses" and + languages: "Python C". The engine might return results "curses" in "C" and "ncurses" in + "Python"! + + To work around that, you can use two search groups: one for "curses" in + "Python", and another for "curses" in "C". bitshift will return the union of both sets of search results. +
++ No content, yet. +
++ bitshift is (gasp) open-source! The project is hosted on + GitHub; feel free to file an issue or submit a pull request! +
+