Selaa lähdekoodia

Work on #74. Add docs route, partly-skeleton page.

Add:
        templates/docs.html
                -Add a skeleton structure for the documentation page.
                -Add some content to certain sections.
tags/v1.0^2
Severyn Kozak 10 vuotta sitten
vanhempi
commit
764398c274
3 muutettua tiedostoa jossa 46 lisäystä ja 0 poistoa
  1. +4
    -0
      app.py
  2. +41
    -0
      templates/docs.html
  3. +1
    -0
      templates/layout.html

+ 4
- 0
app.py Näytä tiedosto

@@ -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


+ 41
- 0
templates/docs.html Näytä tiedosto

@@ -0,0 +1,41 @@
= extends "layout.html"

= block title
docs
= endblock

= block body
<h1>Usage</h1>
<p>
bitshift is a search-engine optimized for source code: beyond supporting searches with the full range of ASCII
symbols, the engine <em>understands</em> 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.

<h2>general search</h2>
<p>
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.
</p>

<h2>advanced search</h2>
<p>
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.

<h3>search fields</h3>
<p>
</p>

<h3>search groups</h3>
<p></p>
</p>
</p>

<h1>Handwritten Queries</h1>
<p></p>

<h1>Get involved</h1>
<p></p>
= endblock

+ 1
- 0
templates/layout.html Näytä tiedosto

@@ -40,6 +40,7 @@
<div id="footer">
<a href="/">home</a>
<a href="/about">about</a>
<a href="/docs">docs</a>
<a href="/developers">developers</a>
</div>
</div>


Ladataan…
Peruuta
Tallenna