diff options
| -rw-r--r-- | www/git.md | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -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 ----------------------------------------- |