[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[www] branch master updated: how to write news.
From: |
gnunet |
Subject: |
[www] branch master updated: how to write news. |
Date: |
Mon, 04 Nov 2019 19:23:33 +0100 |
This is an automated email from the git hooks/post-receive script.
ng0 pushed a commit to branch master
in repository www.
The following commit(s) were added to refs/heads/master by this push:
new 8f06234 how to write news.
8f06234 is described below
commit 8f0623477453028f0ed8426d4c6371d543a96be0
Author: ng0 <address@hidden>
AuthorDate: Mon Nov 4 18:20:52 2019 +0000
how to write news.
---
README | 42 ++++++++++++++++++++++++++++++++++++++++++
1 file changed, 42 insertions(+)
diff --git a/README b/README
index d65adf7..1718c38 100644
--- a/README
+++ b/README
@@ -53,11 +53,53 @@ dist/ 3rd party content (bootstrap 4,
font-awesome)
common/ jinja2 templates.
template.py operates on template directory and produces
output in 'rendered/' directory
+news/ One file per news post. See also "Writing News"
The 'dist' and 'static' directories will be copied to the output
directory ('rendered/') in the 'all' phase of make. robots.txt
is copied to relevant folders.
+Writing News
+============
+
+Writing news posts for gnunet.org involves a couple of steps.
+If you intend to write a new post, read this carefully.
+
+* Every news post is wrapped in an <article> element, outside
+ of the news post itself.
+
+* Every news post must have its headline in an <h1> element.
+ Ideally you don't use more than 1 <h1> in the news post.
+ This can change in the future. The first h1 is what gets
+ assigned as the title for the rss feed item for this post.
+
+* Every news post must get added as an dict to the newspost list
+ in template.py. If you are not sure what those words mean, search
+ "newsposts" in template.py. There you will find a structure where
+ you have to add a new member including the "," at the end.
+ New posts get added to the top of the list, not at the bottom
+ (this list is also responsible for the 5 newest entries on the
+ frontpage).
+
+ {
+ 'page': 'name-of-page.html',
+ 'date': '2019-10-31',
+ 'title': 'My new post'
+ },
+
+ * page must be the name of the file without the leading news/
+ * date must be a valid date in exactly this format.
+ * title can be any title but preferable equal to the title (<h1>)
+ in the file.
+
+* If you use website internal links in your post, do not use plain
+ href targets. Read template.py and grep for *url* to see what can
+ be used and grep the rest of the pages for examples how to use
+ these functions.
+
+* Last but least build the website locally and check if the news
+ post renderes correctly.
+
Developing with GNU Guix
========================
--
To stop receiving notification emails like this one, please contact
address@hidden.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [www] branch master updated: how to write news.,
gnunet <=