diff --git a/README.md b/README.md index 337b7e5..742f753 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,79 @@ -# simplyOpen - -Theme for static website generator pelican inspired by pelican-simplegrey, but without all the datadealer (Google, Twitter, Facebook) stuff. \ No newline at end of file +## simplyOpen ## + +## Screenshot ## + +![screenshot](screenshot.png) + + +## Options ## + +Theme inspired by the mkdocs default theme, without all the datadealer (Google, Twitter, Facebook) stuff. [Federation Widget](https://github.com/LubuWest/federation-widget) in sidebar (works currently only with Friendica). Social links to Mastodon, Matrix, Friendica, Diaspora, Misskey,... +EMail and License is displayed in the footer. + +Javascript only used for Federation Widget. + +Configuration in pelicanconf.py: +``` + EMAIL='x@y.com' + + SOCIAL = (('Diaspora', 'https://diasp.eu/...'), + ('Friendica', 'https://friendica.eu/profile/...'), + ('Forgejo', 'https://codeberg.org...'), + ('Funkwhale', 'https://abc.de/...'), + ('Gitea', 'https://abc.de/...'), + ('Github', 'https://github.com/...'), + ('Gitlab', 'https://gitlab.com/...'), + ('Gnusocial', 'https://www.gnusocial.no/...'), + ('Hubzilla', 'https://abc.de/...'), + ('Mastodon', 'https://mastodon.social/...'), + ('Matrix', 'https://mastodon.social/...'), + ('Misskey', 'https://misskey.com/...'), + ('Movim', 'https://pod.movim.eu/?q=...'), + ('Peertube', 'https://peertube.com/'), + ('Pixelfed', 'https://pixelfed.com/...'), + ('Pleroma', 'https://pleroma.com/...'), + ('Pixelfed', 'https://pixelfed.com/...'), + ('Plume', 'http://plume.come/'), + ('Pixelfed', 'https://pixelfed.com/...'), + ('Pump.io', 'https://pump.io/...'), + ('RedMatrix', 'https://red.com/...'), + ('XMPP', 'abc@jabber.de')) + + # License (choose one) + LICENSE = 'CC-BY-SA', 'CC-BY', 'CC-BY-NC', 'CC-BY-NC-SA', 'ALL RIGHTS RESERVED' + + FEDERATION_TIMELINE = (('domain','https://loma.ml'), # CORS headers must be set at the Friendica server, add the following to .htaccess + # Header add Access-Control-Allow-Origin "https://myblog.com" + # Header add Access-Control-Allow-Methods: "GET" + + ('user','startrek'), + ('max','5'), + ('type','user'), # could be 'group' to follow a group + ('servertype','friendica'),) # could be 'diaspora', 'friendica' or 'hubzilla' +``` + +## Project documentation ## +For displaying project Markdown files as website similar to mkdocs, additional parameters should be set: + +``` +CATEGORIES_ON_SIDEBAR = 'left' # 'right' or 'none' +# If 'left', directory names are used as menu button. If files are not in subdirectories, filenames are used + +FILENAME_METADATA = '(?P
')+3,article.indexOf('
')+33); +var search = friendica_domain + "/search?search=" + article_name.replace(/ /gi,'+'); +var http, http2 = null; +var ergebnis = ""; + +http = new XMLHttpRequest(); +if (http !== null) { + http.open("GET", search, true); + http.onreadystatechange = SearchFriendica; + http.send(null); +} + +function SearchFriendica() { + if (http.readyState == 4 && http.status==200) { + var SearchResult= http.responseText; + var start = SearchResult.indexOf('wall-item-bottom'); + var start2 = SearchResult.indexOf('a href=\'http',start); + var end = SearchResult.indexOf('id',start); + ergebnis = SearchResult.substring(start2+8,end-2); + } + +http2 = new XMLHttpRequest(); + if (http2 !== null) { + http2.open("GET", ergebnis, true); + http2.onreadystatechange = SearchComments; + http2.send(null); +} + +function SearchComments() { + if (http.readyState == 4 && http.status == 200) { + var CommentsResult = http2.responseText; + var ergebnisse = ("