[Static][Docs]: Formatting

This commit is contained in:
Denis Zheleztsov 2021-04-02 18:03:28 +03:00
parent 74c0562b59
commit a58bcecab6
Signed by: Difrex
GPG Key ID: D423378A747E202E
7 changed files with 132 additions and 1 deletions

View File

@ -240,11 +240,19 @@ func Serve(opts *ServeOpts) {
// Simple and clean SSR UI // Simple and clean SSR UI
ssr := newSSR(opts.TemplatesDir, opts.ES) ssr := newSSR(opts.TemplatesDir, opts.ES)
r.HandleFunc("/", ssr.ssrRootHandler) r.HandleFunc("/", ssr.ssrRootHandler)
// Forum
r.HandleFunc("/forum/page/{page:[0-9]+}", ssr.ssrForumHandler) r.HandleFunc("/forum/page/{page:[0-9]+}", ssr.ssrForumHandler)
// Echo
r.HandleFunc("/echo/{echo:[a-z0-9-_.]+}/page/{page:[0-9]+}", ssr.echoViewHandler) r.HandleFunc("/echo/{echo:[a-z0-9-_.]+}/page/{page:[0-9]+}", ssr.echoViewHandler)
// Thread
r.HandleFunc("/thread/{topicid:[a-z0-9-]+}", ssr.threadViewHandler) r.HandleFunc("/thread/{topicid:[a-z0-9-]+}", ssr.threadViewHandler)
// Single message
r.HandleFunc("/msg/{msgid:[a-zA-Z0-9]{20}}", ssr.singleMessageHandler) r.HandleFunc("/msg/{msgid:[a-zA-Z0-9]{20}}", ssr.singleMessageHandler)
// Search
r.HandleFunc("/find", ssr.searchHandler).Methods(http.MethodGet) r.HandleFunc("/find", ssr.searchHandler).Methods(http.MethodGet)
// Docs
// formatting
r.HandleFunc("/docs/formatting", ssr.docsFormattingHandler)
if opts.ServeStatic { if opts.ServeStatic {
r.PathPrefix("/static/").Handler(http.StripPrefix("/static/", http.FileServer(http.Dir(opts.StaticDir)))) r.PathPrefix("/static/").Handler(http.StripPrefix("/static/", http.FileServer(http.Dir(opts.StaticDir))))

View File

@ -173,6 +173,18 @@ func (s *ssr) echoViewHandler(w http.ResponseWriter, r *http.Request) {
} }
} }
func (s *ssr) docsFormattingHandler(w http.ResponseWriter, r *http.Request) {
tpl, err := s.getTemplate("docs_formatting")
if err != nil {
log.Error(err)
return
}
if err := tpl.Execute(w, s.newPageData("docs: formatting", nil, 1, false)); err != nil {
log.Error(err)
}
}
func (s *ssr) singleMessageHandler(w http.ResponseWriter, r *http.Request) { func (s *ssr) singleMessageHandler(w http.ResponseWriter, r *http.Request) {
tpl, err := s.getTemplate("message") tpl, err := s.getTemplate("message")
if err != nil { if err != nil {

View File

@ -36,6 +36,13 @@
new new
</a> </a>
</div> </div>
<div class="nav-item">
<a class="nav-link"
href="/docs/formatting"
role="button">
doc
</a>
</div>
</ul> </ul>
<form method="get" action="/find" class="d-flex"> <form method="get" action="/find" class="d-flex">
<input <input

View File

@ -16,6 +16,10 @@
color: #eee8d5; color: #eee8d5;
} }
pre {
color: #2aa198;
}
.base2 { .base2 {
background-color: #073642; background-color: #073642;
color: #eee8d5; color: #eee8d5;
@ -57,6 +61,14 @@
box-shadow: 0px 0px 15px #002b36; box-shadow: 0px 0px 15px #002b36;
} }
.docs a {
color: #268bd2;
}
.docs-subheader a {
text-decoration: none;
}
@media only screen and (max-width: 1000px) { @media only screen and (max-width: 1000px) {
.dynamic-post { .dynamic-post {
margin-bottom: 0.5em; margin-bottom: 0.5em;

12
templates/views/docs.html Normal file
View File

@ -0,0 +1,12 @@
{{ template "header" . }}
{{ template "style" }}
<div class="container-fluid mt-5 docs">
<div class="container dynamic-bg dynamic-post">
<h2>message formating convention</h2>
</div>
</div>
{{ template "footer" }}

View File

@ -0,0 +1,80 @@
{{ template "header" . }}
{{ template "style" }}
<div class="container-fluid mt-5 docs">
<div class="container dynamic-bg dynamic-post">
<h2>message formating convention</h2>
<div class="docs-subheader" id="code_blocks">
<h3><a href="#code_blocks">Code blocks</a></h3>
<p>
Put your code betwen <i>====</i>
<div id="code_example1">
<pre>
====
for i in $(seq 1 25); do
sleep 1
done
====
</pre>
</div>
</p>
</div>
<div class="docs-subheader" id="headers">
<h3><a href="#headers">Headers</a></h3>
<p>
Put your header after <i>==</i> from the beginning of line
<div id="code_example2">
<pre>
== This is my header!
Regular text
</pre>
</div>
</p>
</div>
<div class="docs-subheader" id="quotes">
<h3><a href="#quotes">Quotes</a></h3>
<p>
Simple quoting
<pre>
&gt;&gt; Double quote
&gt; Quoted text
Answer
</pre>
</p>
<p>
Quoting with an author name
<pre>
Author&gt; Quoted text
Answer
</pre>
</p>
</div>
<div class="docs-subheader" id="links">
<h3><a href="#links">Links</a></h3>
<p>
Links to the message
<pre>
ii://LzGnRCl9R0pwz6JHdShE
</pre>
</p>
<p>
Links to the echo
<pre>
ii://pipe.2032
</pre>
</p>
</div>
</div>
</div>
{{ template "footer" . }}