Added more docs.

This commit is contained in:
Relintai 2022-02-15 00:00:50 +01:00
parent 4bd9975350
commit 71f8a12997
2 changed files with 21 additions and 1 deletions

View File

@ -10,6 +10,13 @@
#include "web/http/request.h" #include "web/http/request.h"
// This class will load and process all md files from the folder set to it's articles_folder property,
// and serve every file from the directory set to it's serve_folder property.
// if it finds a summary.md, it will serve it as the root.
// It uses pagination.
// THe links is generates currently look like: <url>/01_test.md
// files are served under <url>/files/<file>
class PagedArticle : public WebNode { class PagedArticle : public WebNode {
RCPP_OBJECT(PagedArticle, WebNode); RCPP_OBJECT(PagedArticle, WebNode);

View File

@ -9,7 +9,20 @@
#include "web/http/request.h" #include "web/http/request.h"
// todo pagination // This class will load and process all md files from the folder set to it's folder property,
// and generate one page from them. TThe files are processed in alphabetical order.
// The generated HTML looks like:
// render_menu()
// <div class="article_list_entry">
// Contents of the first md file.
// </div>
// <div class="article_list_entry">
// Contents of the second md file.
// </div>
// ...
// </div>
class PagedArticles : public WebNode { class PagedArticles : public WebNode {
RCPP_OBJECT(PagedArticles, WebNode); RCPP_OBJECT(PagedArticles, WebNode);