Merge pull request #150 from bkmgit/markdown-top-pages

Markdown top pages

Author: jubalh

Makefile

@@ -1,19 +1,22 @@
 SBLG = sblg
 XSLTPROC = xsltproc
+LOWDOWN = lowdown
 PREFIX = $(PWD)/site
 BLOG_SRC_TOP_DIR = blogsource/content
 BLOG_POST_SRC_DIR = $(BLOG_SRC_TOP_DIR)/post
 BLOG_POST_OUT_TOP_DIR = blog
 BLOG_POST_OUT_DIR = $(BLOG_POST_OUT_TOP_DIR)/post
 BLOG_POSTS = $(wildcard $(BLOG_POST_SRC_DIR)/*.md)
-BLOG_POSTS_OUT = $(subst $(BLOG_POST_SRC_DIR), $(BLOG_POST_OUT_DIR),  $(BLOG_POSTS:.md=.html))
+BLOG_POSTS_OUT = $(subst $(BLOG_POST_SRC_DIR), $(BLOG_POST_OUT_DIR), $(BLOG_POSTS:.md=.html))
 CONTRIBUTORS_SRC_DIR = blogsource/content/contributors
 CONTRIBUTORS_OUT_DIR = contributors
 CONTRIBUTORS = $(wildcard $(CONTRIBUTORS_SRC_DIR)/*.md)
 PAGES_SRC_DIR = pagesource
-PAGES_SRC = $(wildcard $(PAGES_SRC_DIR)/*.xml)
-PAGES_SRC += xeps.xml
-PAGES = $(subst $(PAGES_SRC_DIR)/,,$(PAGES_SRC:.xml=.html))
+PAGES_SRC = $(wildcard $(PAGES_SRC_DIR)/*.md)
+PAGES_MD_TO_XML = $(subst $(PAGES_SRC_DIR)/,,$(PAGES_SRC:.md=.xml))
+PAGES_XML = $(PAGES_MD_TO_XML)
+PAGES_XML += xeps.xml
+PAGES = $(PAGES_XML:.xml=.html)
 REDIRECTS_DIR = pageredirects
 REDIRECTS_SRC = $(wildcard $(REDIRECTS_DIR)/*.html)
 REDIRECTS = $(subst $(REDIRECTS_DIR)/,,$(REDIRECTS_SRC))
@@ -42,25 +45,40 @@ install:  index.html $(PAGES) themegallery.html $(BLOG_POSTS_OUT) $(BLOG_POST_OU
 	cp -p -r tarballs $(PREFIX)
 
 
-index.html: landing-template.xml index.xml profanity_version.txt
+index.html: landing-template.xml index.md profanity_version.txt
 	sed -e 's/$${version}/$(VERSION)/g' \
 	    -e 's/$${tar_xz_sha256}/$(TAR_XZ_SHA256)/g' \
-	    -e 's/$${zip_sha256}/$(ZIP_SHA256)/g' index.xml > index.gen.xml
-	$(SBLG) -o $@ -t landing-template.xml -c index.gen.xml
-	rm -f index.gen.xml
+	    -e 's/$${zip_sha256}/$(ZIP_SHA256)/g' index.md > index.tmpmd
+	echo "<article data-sblg-article=\"1\" data-sblg-set-title=\"Profanity, a console based XMPP client - Home\" data-sblg-set-subtitle=\"A console based XMPP client\">"  >$(@:.html=.xml)
+	$(LOWDOWN) --html-no-head-ids  --html-no-skiphtml --html-no-escapehtml index.tmpmd >>$(@:.html=.xml)
+	echo "</article>" >>$(@:.html=.xml)
+	sed -e 's|<p>$${div_content}</p>|<div id="content">|g' $(@:.html=.xml) > $(@:.html=.tmpxml)
+	sed -e 's|<p>$${div_features}</p>|<div id="features">|g' $(@:.html=.tmpxml) > $(@:.html=.xml)
+	sed -e 's|<p>$${div_screenshots}</p>|<div id="screenshots">|g' $(@:.html=.xml) > $(@:.html=.tmpxml)
+	sed -e 's|<p>$${div_end}</p>|</div>|g' $(@:.html=.tmpxml) > $(@:.html=.xml)
+	$(SBLG) -o $@ -t landing-template.xml -c index.xml
+	rm -f index.xml index.tmpxml index.tmpmd
 
-$(PAGES): manual-template.xml xeplist
-	cp --preserve=mode,ownership,timestamps $(addprefix $(PAGES_SRC_DIR)/,$(@:.html=.xml)) .
+$(PAGES): manual-template.xml $(PAGES_MD_TO_XML) xeplist
 	$(SBLG) -o $@ -t manual-template.xml -c $(@:.html=.xml)
-	rm -f $(PAGES:.html=.xml)
+	rm -f $(@:.html=.xml)
+
+$(PAGES_MD_TO_XML): $(PAGES_SRC)
+	cp $(addprefix $(PAGES_SRC_DIR)/,$(@:.xml=.md)) .
+	echo "<article id=\"manual\" data-sblg-article=\"1\" data-sblg-set-title=\"`$(LOWDOWN) -X title $(@:.xml=.md)`\" data-sblg-set-subtitle=\"`$(LOWDOWN) -X subtitle $(@:.xml=.md)`\">"  >$@
+	$(LOWDOWN) --html-no-skiphtml --html-no-escapehtml $(subst .xml,.md,$@) >>$@
+	echo "</article>" >>$@
+	sed -e 's|<p>$${section_start}</p>|<section>|g' $@ > $(@:.xml=.tmpxml)
+	sed -e 's|<p>$${section_end}</p>|</section>|g' $(@:.xml=.tmpxml) > $@
+	rm -f $(@:.xml=.md) $(@:.xml=.tmpxml)
 
 xeplist: $(PAGES_SRC_DIR)/doap-stylesheet/style.xsl $(PAGES_SRC_DIR)/doap/profanity.doap \
 	$(PAGES_SRC_DIR)/xeplist/xeplist.xml
 	cp --preserve=mode,ownership,timestamps $(PAGES_SRC_DIR)/xeplist/xeplist.xml \
 		$(PAGES_SRC_DIR)/doap-stylesheet/
 	$(XSLTPROC) $(PAGES_SRC_DIR)/doap-stylesheet/style.xsl \
 		$(PAGES_SRC_DIR)/doap/profanity.doap \
-		> $(PAGES_SRC_DIR)/xeps.xml
+		> xeps.xml
 	rm $(PAGES_SRC_DIR)/doap-stylesheet/xeplist.xml
 
 themegallery.html: gallery-template.xml

README.md

@@ -1,13 +1,13 @@
 Sources for https://profanity-im.github.io
 
-The website is generated from XML and Markdown sources using [sblg](https://kristaps.bsd.lv/sblg/) and [lowdown](https://kristaps.bsd.lv/lowdown).
+The website is generated from XML templates and Markdown sources using [sblg](https://kristaps.bsd.lv/sblg/) and [lowdown](https://kristaps.bsd.lv/lowdown).
 
 ## Reference
 
 | To Change... | Edit File(s) | Format |
 | :--- | :--- | :--- |
-| **Home Page (Landing)** | `index.xml` | XML Fragment |
-| **Top-Level Pages** (FAQ, Donate, etc.) | `pagesource/*.xml` | XML Fragment |
+| **Home Page (Landing)** | `index.content.md`, `index.features.md` and `index.screenshots.md` | Markdown |
+| **Top-Level Pages** (FAQ, Donate, etc.) | `pagesource/*.md` | Markdown |
 | **Blog Posts** | `blogsource/content/post/*.md` | Markdown |
 | **Blog User Profiles** | `blogsource/content/contributors/*.md` | Markdown |
 | **Site Header/Footer (Home)** | `landing-template.xml` | HTML Template |
@@ -17,7 +17,7 @@ The website is generated from XML and Markdown sources using [sblg](https://kris
 | **Style** | `css/*.css` | CSS |
 
 ### Page Sources
-The source files for the landing page (`index.xml`) and other top level pages in `pagesource/` are XML fragments. They contain the HTML content for the body, which is then injected into the appropriate header and footer templates. The list of supported XEPS is generated using a git submodule for https://github.com/profanity-im/profanity/blob/master/profanity.doap.
+The source files for the landing page (`index.content.md`, `index.features.md` and `index.screenshots.md`) and other top level pages in `pagesource/` are writen in Markdown. They are transformed to HTML and then injected into the appropriate header and footer templates.  The list of supported XEPS is generated using a git submodule for https://github.com/profanity-im/profanity/blob/master/profanity.doap.
 
 ### Blog
 Blog posts and contributor profiles are written in Markdown.
@@ -55,6 +55,6 @@ When a new version of Profanity is released:
 
 1. Update the version string in `profanity_version.txt`.
 2. Add the new `.tar.xz` and `.zip` source tarballs to the `tarballs/` directory.
-3. Generate the documentation for the new version (`profanity docgen` see RELEASE_NOTES.md in the profanity repo) and copy it to a new subdirectory in `guide/`. Add a link to the new guide in `pagesource/userguide.xml`.
+3. Generate the documentation for the new version (`profanity docgen` see RELEASE_NOTES.md in the profanity repo) and copy it to a new subdirectory in `guide/`. Add a link to the new guide in `pagesource/userguide.md`.
 
 Do not manually update the version strings or SHA-256 hashes in `index.html`. These are calculated dynamically from the files during the build process on GitHub Actions.

blogsource/content/contributors/Makefile

@@ -1,4 +1,5 @@
 SBLG = sblg
+LOWDOWN = lowdown
 CONTRIBUTORS = $(wildcard *.md)
 CONTRIBUTORS_XML = $(CONTRIBUTORS:.md=.xml)
 CONTRIBUTORS_OUT = $(CONTRIBUTORS_XML:.xml=.html)
@@ -12,12 +13,12 @@ $(CONTRIBUTORS_OUT) index.html: $(CONTRIBUTORS_XML) contributor-template.xml con
 $(CONTRIBUTORS_XML): $(CONTRIBUTORS)
 	echo "<article id=\"manual\" data-sblg-article=\"1\">"  >$@
 	echo " <header>" >>$@
-	echo "  <h3>`lowdown -X name $(subst .xml,.md,$@)`</h3>" >>$@
+	echo "  <h3>`$(LOWDOWN) -X name $(subst .xml,.md,$@)`</h3>" >>$@
 	echo " </header>" >>$@
-	test -f img/$(shell lowdown -X name $(subst .xml,.md,$@)).jpg  && \
-	echo " <img src=\"img/`lowdown -X name $(subst .xml,.md,$@)`.jpg\" alt=\"Avatar for `lowdown -X name $(subst .xml,.md,$@)`.\"/>" >>$@ || \
+	test -f img/$(shell $(LOWDOWN) -X name $(subst .xml,.md,$@)).jpg  && \
+	echo " <img src=\"img/`$(LOWDOWN) -X name $(subst .xml,.md,$@)`.jpg\" alt=\"Avatar for `$(LOWDOWN) -X name $(subst .xml,.md,$@)`.\"/>" >>$@ || \
 	echo No image
-	lowdown  $(subst .xml,.md,$@) >>$@
+	$(LOWDOWN) --html-no-skiphtml --html-no-escapehtml $(subst .xml,.md,$@) >>$@
 	echo "</article>" >>$@
 
 clean:

blogsource/content/post/Makefile

@@ -1,4 +1,5 @@
 SBLG = sblg
+LOWDOWN = lowdown
 BLOG_POSTS = $(wildcard *.md)
 
 PAGES_OUT = $(PAGES:.xml=.html)
@@ -19,11 +20,11 @@ $(BLOG_POSTS_OUT): $(BLOG_POSTS_XML) blog-post-template.xml
 $(BLOG_POSTS_XML): $(BLOG_POSTS)
 	echo "<article id=\"manual\" data-sblg-article=\"1\">"  >$@
 	echo " <header>" >>$@
-	echo "  <h3>`lowdown -X title $(subst .xml,.md,$@)`</h3>" >>$@
+	echo "  <h3>`$(LOWDOWN) -X title $(subst .xml,.md,$@)`</h3>" >>$@
 	echo "  <address><a href=\"../../contributors/`lowdown -X authors $(subst .xml,.md,$@)`.html\">`lowdown -X authors $(subst .xml,.md,$@)`</a></address>" >>$@
-	echo "  <time datetime=\"`lowdown -X date $(subst .xml,.md,$@) | cut -f1 -dT`\">`lowdown -X date $(subst .xml,.md,$@) | cut -f1 -dT`</time>" >>$@
+	echo "  <time datetime=\"`$(LOWDOWN) -X date $(subst .xml,.md,$@) | cut -f1 -dT`\">`lowdown -X date $(subst .xml,.md,$@) | cut -f1 -dT`</time>" >>$@
 	echo " </header>" >>$@
-	lowdown  $(subst .xml,.md,$@) >>$@
+	$(LOWDOWN) $(subst .xml,.md,$@) >>$@
 	echo "</article>" >>$@
 
 clean:

index.md

@@ -0,0 +1,69 @@
+title: Profanity, a console based XMPP client - Home
+subtitle: A console based XMPP client
+
+${div_content}
+
+#### Profanity is a console based XMPP client written in C using [ncurses](http://www.gnu.org/software/ncurses/) and [libstrophe](http://strophe.im/libstrophe/), inspired by  [Irssi](http://irssi.org/)
+
+
+Available on Linux, FreeBSD, OpenBSD, OSX, Windows and Android (Termux)  
+
+Do you like Profanity?  
+Consider [donating](donate.html)!  
+
+**Latest release:**
+**[profanity-${version}.tar.xz](tarballs/profanity-${version}.tar.xz id="download-tarball")**  
+sha256:  <span class="hash">${tar_xz_sha256}</span>  
+  
+**[profanity-${version}.zip](tarballs/profanity-${version}.zip id="download-zip")**  
+sha256:  <span class="hash">${zip_sha256}</span>  
+
+**Documentation:**  
+[User Guide](userguide.html)  
+[FAQ](faq.html)  
+[Supported XEPs](xeps.html)  
+[Plugins](plugins.html)  
+[Reporting Issues](issues.html)  
+[How to help out](helpout.html)  
+[Blog](blog/post/index.html)  
+[Theme Gallery](themegallery.html)  
+
+**Links:**  
+[GitHub](http://github.com/profanity-im/profanity)  
+[Mailing List](https://lists.posteo.de/listinfo/profanity)  
+[X](https://x.com/profanityim)  
+[xmpp:profanity@rooms.dismail.de](xmpp:profanity@rooms.dismail.de?join)  
+
+${div_end}
+
+${div_features}
+
+### Features
+
+![](images/profanity_logo.png "Profanity Logo")
+
+- Supports XMPP chat services
+- MUC chat room support
+- OTR, PGP and OMEMO encryption
+- Roster management
+- Flexible resource and priority settings
+- Desktop notifications
+- Plugins in Python and C
+
+${div_end}
+
+${div_screenshots}
+
+### Screenshots
+
+- [![](images/prof-1.webp)](images/prof-1.webp)
+- [![](images/profroster.webp)](images/profroster.webp)
+- [![](images/profoldterm.webp)](images/profoldterm.webp)
+- [![](images/roompanel.webp)](images/roompanel.webp)
+- [![](images/profxfce.webp)](images/profxfce_small.webp)
+- [![](images/prof_mac.webp)](images/prof_mac_small.webp)
+- [![](images/prof-win.webp)](images/prof-win.webp)
+- [![](images/prof-pink.webp)](images/prof-pink.webp)
+- [![](images/2-barebones-chat.webp)](images/2-barebones-chat.webp)
+
+${div_end}

index.xml

@@ -0,0 +1,52 @@
+title: Profanity, a console based XMPP client - Account Configuration
+subtitle: Account Configuration
+
+${section_start}
+
+### Contents
+
+- [Configuring Accounts](#configuring-accounts)
+
+${section_end}
+
+${section_start}
+
+### Configuring Accounts
+
+The [<code>/account</code>](reference.html#account) command should be used to
+modify the settings below.
+
+The following is an example account configuration file with two configured
+accounts.
+
+```[jabber]
+enabled=true
+priority.online=10
+priority.chat=20
+priority.away=0
+priority.xa=0
+priority.dnd=-10
+jid=someone@jabber.org
+resource=laptop
+presence.last=xa
+presence.login=online
+muc.service=conference.jabber.org
+muc.nick=aperson
+
+[work]
+enabled=true
+priority.online=2
+priority.chat=1
+priority.away=0
+priority.xa=-5
+priority.dnd=-10
+jid=bob.smith@mycompany.org
+server=talk.mycompany.org
+resource=office
+presence.last=online
+presence.login=away
+muc.service=rooms.mycompany.org
+muc.nick=smithy
+```
+
+${section_end}