diff --git a/static/sass/docs.sass b/static/sass/docs.sass new file mode 100644 index 0000000..a96cd57 --- /dev/null +++ b/static/sass/docs.sass @@ -0,0 +1,39 @@ +@import variables + +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/templates/docs.html b/templates/docs.html index 70fd7f9..9a319eb 100644 --- a/templates/docs.html +++ b/templates/docs.html @@ -4,38 +4,115 @@ 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 typing; when - you stop typing for a short period of time, we'll automtically execute a query for you. As you scroll down the - results page, the front-end will query our server and seamlessly load more and more results. -
- -- 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. - -
-
+ 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. -
+ 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"! -
+ 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! +
+