From 5b32e553b96e7971099f82ed209ea4e8ada2d196 Mon Sep 17 00:00:00 2001 From: Leah Rowe Date: Tue, 6 Jun 2017 12:07:07 +0100 Subject: git page: further document Libreboot's static site generator This is useful for people who want to work on much larger changes to the Web site or documentation. --- www/git.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'www/git.md') diff --git a/www/git.md b/www/git.md index f6ebab77..44644ec3 100644 --- a/www/git.md +++ b/www/git.md @@ -33,6 +33,28 @@ We currently have a shortage of people who possess the skill to write and maintain good documentation for Libreboot, so we welcome any and all contributions! +The .md files are written in Pandoc flavoured Markdown. The following scripts +form Libreboot's *static site generator* which converts the Markdown files into +HTML, to create the website: + +- index.sh: generates the news feed (on the News section of the website) +- publish.sh: converts an .md file to an .html file +- generate.sh: with calls to index.sh and publish.sh, compiles the entire + Libreboot website + +To view your local version of the website, it is advisable to install an HTTP +server (e.g. nginx, lighttpd) and configure it so that the `www` directory in +your local Git repository is the document root. With this, you can run +`generate.sh` and view your own version of the website locally. This can be +useful for larger changes (including structural) if you're making many large +improvements to the website. However, it is possible to just edit the Markdown +files with a text editor and submit those, or view individual .html files +(generated by publish.sh) in a Web browser (e.g. Firefox). + +At present, the site and documentation are optimized for use on the Web (as +HTML, generated by Pandoc), but we would like to possibly support other use +cases aswell, such as PDF documents for printed manuals. + General guidelines for submitting patches ----------------------------------------- -- cgit v1.2.3-70-g09d2