Added documentation on markdown
authorRuben Rodriguez <ruben@fsf.org>
Mon, 9 Sep 2019 19:21:39 +0000 (15:21 -0400)
committerRuben Rodriguez <ruben@fsf.org>
Mon, 9 Sep 2019 19:21:39 +0000 (15:21 -0400)
2019/README.md

index 11b6645f432432ed2bb6c50c8110bfa9a349776a..b09b967780cf63f5ec8a45197073a4c369d96770 100644 (file)
@@ -88,6 +88,10 @@ chmod +x foo.html
 
 Replace `foo.html` with the desired file name.
 
+## Using Markdown
+
+Static pages can be edited using markdown by creating a index.mdwn file in the appropriate subdirectory (e.g. ./fun/index.mdwn) and running 'make wikipages'. Note that the .mdwn files should have the ```<!--#include...``` lines in place, everything else being regular markdown. It is a requirement to have the python-markdown package installed to run 'make wikipages'. To add this functionality to new pages, edit the Makefile. Also note that the index.html in those directories would be generated from the mdwn file and should not be edited directly.
+
 ## Modifying top-right corner
 
 In the `/2019/includes/banner.html` find the `...#top-right-desktop