libreboot

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README

commit 5c5b7d947bd62a2b4bfbcfb856df31271e2b866f
parent a81dbc79f5401d94954fa9efdcda093aa789d4b9
Author: Leah Rowe <info@minifree.org>
Date:   Wed,  5 Apr 2017 12:33:43 +0000

Merge branch 'nav' of libreboot/libreboot into master

Diffstat:
docs/bsd/freebsd.md | 4+++-
docs/bsd/index.md | 4+++-
docs/bsd/netbsd.md | 4+++-
docs/bsd/openbsd.md | 4+++-
docs/depthcharge/index.md | 4+++-
docs/gnulinux/configuring_parabola.md | 4+++-
docs/gnulinux/encrypted_debian.md | 4+++-
docs/gnulinux/encrypted_parabola.md | 4+++-
docs/gnulinux/grub_boot_installer.md | 4+++-
docs/gnulinux/grub_cbfs.md | 4+++-
docs/gnulinux/grub_hardening.md | 4+++-
docs/gnulinux/index.md | 4+++-
docs/grub/index.md | 4+++-
docs/hcl/c201.md | 4+++-
docs/hcl/d510mo.md | 4+++-
docs/hcl/d945gclf.md | 4+++-
docs/hcl/ga-g41m-es2l.md | 4+++-
docs/hcl/gm45_remove_me.md | 4+++-
docs/hcl/imac52.md | 4+++-
docs/hcl/index.md | 4+++-
docs/hcl/kcma-d8.md | 4+++-
docs/hcl/kfsn4-dre.md | 4+++-
docs/hcl/kgpe-d16.md | 4+++-
docs/hcl/r400.md | 4+++-
docs/hcl/t400.md | 4+++-
docs/hcl/t500.md | 4+++-
docs/hcl/x200.md | 4+++-
docs/index.md | 4+++-
docs/install/bbb_setup.md | 4+++-
docs/install/c201.md | 4+++-
docs/install/d510mo.md | 4+++-
docs/install/d945gclf.md | 4+++-
docs/install/ga-g41m-es2l.md | 4+++-
docs/install/index.md | 4+++-
docs/install/kcma-d8.md | 4+++-
docs/install/kgpe-d16.md | 4+++-
docs/install/r400_external.md | 4+++-
docs/install/rpi_setup.md | 4+++-
docs/install/t400_external.md | 4+++-
docs/install/t500_external.md | 4+++-
docs/install/t60_unbrick.md | 4+++-
docs/install/x200_external.md | 4+++-
docs/install/x60_unbrick.md | 4+++-
docs/install/x60tablet_unbrick.md | 4+++-
docs/misc/bbb_ehci.md | 4+++-
docs/release.md | 4+++-
www/generate.sh | 1+
www/publish.sh | 32++++++++++++++++++++++++++------
www/rsync.md | 4+++-
www/template.html | 70++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
50 files changed, 238 insertions(+), 53 deletions(-)

diff --git a/docs/bsd/freebsd.md b/docs/bsd/freebsd.md @@ -1,4 +1,6 @@ -% How to install FreeBSD on a libreboot system +--- +title: How to install FreeBSD on a libreboot system +... This section relates to preparing, booting and installing FreeBSD on your libreboot system, using nothing more than a USB flash drive (and diff --git a/docs/bsd/index.md b/docs/bsd/index.md @@ -1,4 +1,6 @@ -% BSD projects +--- +title: BSD projects +... This section relates to dealing with BSD projects: preparing bootable USB drives, changing the default GRUB menu and so on. diff --git a/docs/bsd/netbsd.md b/docs/bsd/netbsd.md @@ -1,4 +1,6 @@ -% How to install NetBSD on a libreboot system +--- +title: How to install NetBSD on a libreboot system +... This section relates to preparing, booting and installing NetBSD on your libreboot system, using nothing more than a USB flash drive (and *dd*). diff --git a/docs/bsd/openbsd.md b/docs/bsd/openbsd.md @@ -1,4 +1,6 @@ -% How to install LibertyBSD or OpenBSD on a libreboot system +--- +title: How to install LibertyBSD or OpenBSD on a libreboot system +... NOTE: This guide was written for OpenBSD by the person who contributed it, but the libreboot project recommends LibertyBSD. LibertyBSD is a diff --git a/docs/depthcharge/index.md b/docs/depthcharge/index.md @@ -1,4 +1,6 @@ -% Depthcharge payload +--- +title: Depthcharge payload +... This section relates to the depthcharge payload used in libreboot. diff --git a/docs/gnulinux/configuring_parabola.md b/docs/gnulinux/configuring_parabola.md @@ -1,4 +1,6 @@ -% Configuring Parabola (post-install) +--- +title: Configuring Parabola (post-install) +... Post-installation configuration steps for Parabola GNU+Linux-libre. Parabola is extremely flexible; this is just an example. This example diff --git a/docs/gnulinux/encrypted_debian.md b/docs/gnulinux/encrypted_debian.md @@ -1,4 +1,6 @@ -% Installing Debian or Devuan GNU+Linux with full disk encryption (including /boot) +--- +title: Installing Debian or Devuan GNU+Linux with full disk encryption (including /boot) +... This guide is written for the Debian distribution, but it should also work for Devuan with the net installer. diff --git a/docs/gnulinux/encrypted_parabola.md b/docs/gnulinux/encrypted_parabola.md @@ -1,4 +1,6 @@ -% Installing Parabola or Arch GNU+Linux with full disk encryption (including /boot) +--- +title: Installing Parabola or Arch GNU+Linux with full disk encryption (including /boot) +... Libreboot on x86 uses the GRUB [payload](http://www.coreboot.org/Payloads#GRUB_2) by default, which diff --git a/docs/gnulinux/grub_boot_installer.md b/docs/gnulinux/grub_boot_installer.md @@ -1,4 +1,6 @@ -% How to install GNU+Linux on a libreboot system +--- +title: How to install GNU+Linux on a libreboot system +... This section relates to preparing, booting and installing a GNU+Linux distribution on your libreboot system, using nothing more than a USB diff --git a/docs/gnulinux/grub_cbfs.md b/docs/gnulinux/grub_cbfs.md @@ -1,4 +1,6 @@ -% How to replace the default GRUB configuration file on a libreboot system +--- +title: How to replace the default GRUB configuration file on a libreboot system +... Libreboot on x86 uses the GRUB [payload](http://www.coreboot.org/Payloads#GRUB_2) by default, which diff --git a/docs/gnulinux/grub_hardening.md b/docs/gnulinux/grub_hardening.md @@ -1,4 +1,6 @@ -% GRUB hardening +--- +title: GRUB hardening +... This guide deals with various ways in which you can harden your GRUB configuration, for security purposes. These steps are optional, but diff --git a/docs/gnulinux/index.md b/docs/gnulinux/index.md @@ -1,4 +1,6 @@ -% GNU+Linux distributions +--- +title: GNU+Linux distributions +... This section relates to dealing with GNU+Linux distributions: preparing bootable USB drives, changing the default GRUB menu and so on. diff --git a/docs/grub/index.md b/docs/grub/index.md @@ -1,4 +1,6 @@ -% GRUB payload +--- +title: GRUB payload +... This section relates to the GRUB payload used in libreboot. diff --git a/docs/hcl/c201.md b/docs/hcl/c201.md @@ -1,4 +1,6 @@ -% ASUS Chromebook C201 +--- +title: ASUS Chromebook C201 +... This is a Chromebook, using the Rockchip RK3288 SoC. It uses an ARM CPU, and has free EC firmware (unlike some other laptops). More RK3288-based diff --git a/docs/hcl/d510mo.md b/docs/hcl/d510mo.md @@ -1,4 +1,6 @@ -% Intel D510MO desktop board +--- +title: Intel D510MO desktop board +... This is a desktop board using intel hardware (circa \~2009, ICH7 southbridge, similar performance-wise to the Libreboot X200. It can make diff --git a/docs/hcl/d945gclf.md b/docs/hcl/d945gclf.md @@ -1,4 +1,6 @@ -% Intel D945GCLF desktop board +--- +title: Intel D945GCLF desktop board +... If you just want flashing instructions, go to [../install/d945gclf.html](https://libreboot.org/docs/install/d945gclf.html) diff --git a/docs/hcl/ga-g41m-es2l.md b/docs/hcl/ga-g41m-es2l.md @@ -1,4 +1,6 @@ -% Gigabyte GA-G41M-ES2L desktop board +--- +title: Gigabyte GA-G41M-ES2L desktop board +... This is a desktop board using intel hardware (circa \~2009, ICH7 southbridge, similar performance-wise to the Libreboot X200. It can make diff --git a/docs/hcl/gm45_remove_me.md b/docs/hcl/gm45_remove_me.md @@ -1,4 +1,6 @@ -% GM45 chipsets: remove the ME (manageability engine) +--- +title: "GM45 chipsets: remove the ME (manageability engine)" +... This sections relates to disabling and removing the ME (Intel **M**anagement **E**ngine) on GM45. This was originally done on the diff --git a/docs/hcl/imac52.md b/docs/hcl/imac52.md @@ -1,4 +1,6 @@ -% Apple iMac 5,2 +--- +title: Apple iMac 5,2 +... Information to be written soon, but this board is merged in libreboot. diff --git a/docs/hcl/index.md b/docs/hcl/index.md @@ -1,4 +1,6 @@ -% Hardware compatibility list +--- +title: Hardware compatibility list +... This sections relates to known hardware compatibility in libreboot. diff --git a/docs/hcl/kcma-d8.md b/docs/hcl/kcma-d8.md @@ -1,4 +1,6 @@ -% ASUS KCMA-D8 desktop/workstation board +--- +title: ASUS KCMA-D8 desktop/workstation board +... This is a desktop board using AMD hardware (Fam10h **and Fam15h** CPUs available). It can also be used for building a high-powered workstation. diff --git a/docs/hcl/kfsn4-dre.md b/docs/hcl/kfsn4-dre.md @@ -1,4 +1,6 @@ -% ASUS KFSN4-DRE server/workstation board +--- +title: ASUS KFSN4-DRE server/workstation board +... This is a server board using AMD hardware (Fam10h). It can also be used for building a high-powered workstation. Powered by libreboot. diff --git a/docs/hcl/kgpe-d16.md b/docs/hcl/kgpe-d16.md @@ -1,4 +1,6 @@ -% ASUS KGPE-D16 server/workstation board +--- +title: ASUS KGPE-D16 server/workstation board +... This is a server board using AMD hardware (Fam10h **and Fam15h** CPUs available). It can also be used for building a high-powered workstation. diff --git a/docs/hcl/r400.md b/docs/hcl/r400.md @@ -1,4 +1,6 @@ -% ThinkPad R400 +--- +title: ThinkPad R400 +... It is believed that all or most R400 laptops are compatible. See notes about [CPU diff --git a/docs/hcl/t400.md b/docs/hcl/t400.md @@ -1,4 +1,6 @@ -% ThinkPad T400 +--- +title: ThinkPad T400 +... It is believed that all or most T400 laptops are compatible. See notes about [CPU diff --git a/docs/hcl/t500.md b/docs/hcl/t500.md @@ -1,4 +1,6 @@ -% ThinkPad T500 +--- +title: ThinkPad T500 +... It is believed that all or most T500 laptops are compatible. See notes about [CPU diff --git a/docs/hcl/x200.md b/docs/hcl/x200.md @@ -1,4 +1,6 @@ -% ThinkPad X200 +--- +title: ThinkPad X200 +... It is believed that all X200 laptops are compatible. X200S and X200 Tablet will also work, [depending on the configuration](#x200s). diff --git a/docs/index.md b/docs/index.md @@ -1,4 +1,6 @@ -% Libreboot documentation +--- +title: Libreboot documentation +... Information about this release can be found at [release.html](release.html). Always check [libreboot.org](/) for updates. diff --git a/docs/install/bbb_setup.md b/docs/install/bbb_setup.md @@ -1,4 +1,6 @@ -% How to program an SPI flash chip with the BeagleBone Black or Teensy 3.1 +--- +title: How to program an SPI flash chip with the BeagleBone Black or Teensy 3.1 +... This document exists as a guide for reading from or writing to an SPI flash chip with the BeagleBone Black, using the diff --git a/docs/install/c201.md b/docs/install/c201.md @@ -1,4 +1,6 @@ -% ASUS Chromebook C201 installation guide +--- +title: ASUS Chromebook C201 installation guide +... These instructions are for installing Libreboot to the ASUS Chromebook C201. Since the device ships with Coreboot, the installation diff --git a/docs/install/d510mo.md b/docs/install/d510mo.md @@ -1,4 +1,6 @@ -% D510MO flashing tutorial +--- +title: D510MO flashing tutorial +... This guide is for those who want libreboot on their Intel D510MO motherboard while they still have the original BIOS present. diff --git a/docs/install/d945gclf.md b/docs/install/d945gclf.md @@ -1,4 +1,6 @@ -% Intel D945GCLF flashing tutorial +--- +title: Intel D945GCLF flashing tutorial +... This guide is for those who want libreboot on their Intel D945GCLF motherboard while they still have the original BIOS present. diff --git a/docs/install/ga-g41m-es2l.md b/docs/install/ga-g41m-es2l.md @@ -1,4 +1,6 @@ -% GA-G41M-ES2L flashing tutorial +--- +title: GA-G41M-ES2L flashing tutorial +... This guide is for those who want libreboot on their Intel GA-G41M-ES2L motherboard while they still have the original BIOS present. diff --git a/docs/install/index.md b/docs/install/index.md @@ -1,4 +1,6 @@ -% Installing libreboot +--- +title: Installing libreboot +... This section relates to installing libreboot on supported targets. diff --git a/docs/install/kcma-d8.md b/docs/install/kcma-d8.md @@ -1,4 +1,6 @@ -% KCMA-D8 external flashing instructions +--- +title: KCMA-D8 external flashing instructions +... Initial flashing instructions for kcma-d8. diff --git a/docs/install/kgpe-d16.md b/docs/install/kgpe-d16.md @@ -1,4 +1,6 @@ -% KGPE-D16 external flashing instructions +--- +title: KGPE-D16 external flashing instructions +... Initial flashing instructions for KGPE-D16. diff --git a/docs/install/r400_external.md b/docs/install/r400_external.md @@ -1,4 +1,6 @@ -% Flashing the R400 with a BeagleBone Black +--- +title: Flashing the R400 with a BeagleBone Black +... Initial flashing instructions for R400. diff --git a/docs/install/rpi_setup.md b/docs/install/rpi_setup.md @@ -1,4 +1,6 @@ -% How to program an SPI flash chip with the Raspberry Pi +--- +title: How to program an SPI flash chip with the Raspberry Pi +... This document exists as a guide for reading from or writing to an SPI flash chip with the Raspberry Pi, using the diff --git a/docs/install/t400_external.md b/docs/install/t400_external.md @@ -1,4 +1,6 @@ -% Flashing the T400 with a BeagleBone Black +--- +title: Flashing the T400 with a BeagleBone Black +... Initial flashing instructions for T400. diff --git a/docs/install/t500_external.md b/docs/install/t500_external.md @@ -1,4 +1,6 @@ -% Flashing the T500 with a BeagleBone Black +--- +title: Flashing the T500 with a BeagleBone Black +... Initial flashing instructions for T500. diff --git a/docs/install/t60_unbrick.md b/docs/install/t60_unbrick.md @@ -1,4 +1,6 @@ -% ThinkPad T60: Recovery guide +--- +title: "ThinkPad T60: Recovery guide" +... This section documents how to recover from a bad flash that prevents your ThinkPad T60 from booting. diff --git a/docs/install/x200_external.md b/docs/install/x200_external.md @@ -1,4 +1,6 @@ -% Flashing the X200 with a BeagleBone Black +--- +title: Flashing the X200 with a BeagleBone Black +... Initial flashing instructions for X200. diff --git a/docs/install/x60_unbrick.md b/docs/install/x60_unbrick.md @@ -1,4 +1,6 @@ -% ThinkPad X60: Recovery guide +--- +title: "ThinkPad X60: Recovery guide" +... This section documents how to recover from a bad flash that prevents your ThinkPad X60 from booting. diff --git a/docs/install/x60tablet_unbrick.md b/docs/install/x60tablet_unbrick.md @@ -1,4 +1,6 @@ -% ThinkPad X60 Tablet: Recovery guide +--- +title: "ThinkPad X60 Tablet: Recovery guide" +... This section documents how to recover from a bad flash that prevents your ThinkPad X60 Tablet from booting. diff --git a/docs/misc/bbb_ehci.md b/docs/misc/bbb_ehci.md @@ -1,4 +1,6 @@ -% EHCI debugging on the BeagleBone Black +--- +title: EHCI debugging on the BeagleBone Black +... EHCI debugging ============== diff --git a/docs/release.md b/docs/release.md @@ -1,4 +1,6 @@ -% Libreboot release information +--- +title: Libreboot release information +... Updated versions of libreboot can be found at [libreboot.org](http://libreboot.org/). diff --git a/www/generate.sh b/www/generate.sh @@ -1,2 +1,3 @@ #!/bin/bash +find -L . -name '*.html' -and -not -name 'template.html' -delete find -L . -name '*.md' -exec ./publish.sh {} \; diff --git a/www/publish.sh b/www/publish.sh @@ -1,18 +1,37 @@ #!/bin/bash +# +# Copyright (C) 2017 Alyssa Rosenzweig <alyssa@rosenzweig.io +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see <http://www.gnu.org/licenses/>. echo $1 FILE=${1%.md} cat $1 > temp.md -# add footer - -echo '' >> temp.md - if [ "${FILE}" != "./index" ]; then - echo -ne '[Back to home](/index.html) -- ' >> temp.md + if [[ $FILE == *index ]] + then + DEST=".." + else + DEST="index.html" + fi + + RETURN="<a href='$DEST'>Back to previous index</a>" fi +echo "" >> temp.md echo "[License](license.md)" >> temp.md # change out .md -> .html @@ -25,4 +44,5 @@ TOC=$(grep -q "^x-toc-enable: true$" temp.md && echo "--toc --toc-depth=2") SMART=$(pandoc -v | grep -q '2\.0' || echo "--smart") # chuck through pandoc -pandoc $TOC $SMART temp.md -s --css /global.css -T Libreboot > $FILE.html +pandoc $TOC $SMART temp.md -s --css /global.css -T Libreboot \ + --template template.html --metadata return="$RETURN"> $FILE.html diff --git a/www/rsync.md b/www/rsync.md @@ -1,4 +1,6 @@ -% Mirroring libreboot +--- +title: Mirroring libreboot +... Create a directory in your web directory (e.g. libreboot/) and put one of these in your crontab: diff --git a/www/template.html b/www/template.html @@ -0,0 +1,70 @@ +<!DOCTYPE html> +<html$if(lang)$ lang="$lang$"$endif$$if(dir)$ dir="$dir$"$endif$> +<head> + <meta charset="utf-8"> + <meta name="generator" content="pandoc"> + <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> +$for(author-meta)$ + <meta name="author" content="$author-meta$"> +$endfor$ +$if(date-meta)$ + <meta name="dcterms.date" content="$date-meta$"> +$endif$ +$if(keywords)$ + <meta name="keywords" content="$for(keywords)$$keywords$$sep$, $endfor$"> +$endif$ + <title>$if(title-prefix)$$title-prefix$ – $endif$$pagetitle$</title> + <style type="text/css">code{white-space: pre;}</style> +$if(quotes)$ + <style type="text/css">q { quotes: "“" "”" "‘" "’"; }</style> +$endif$ +$if(highlighting-css)$ + <style type="text/css"> +$highlighting-css$ + </style> +$endif$ +$for(css)$ + <link rel="stylesheet" href="$css$"> +$endfor$ +$if(math)$ + $math$ +$endif$ + <!--[if lt IE 9]> + <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script> + <![endif]--> +$for(header-includes)$ + $header-includes$ +$endfor$ +</head> +<body> +$for(include-before)$ +$include-before$ +$endfor$ +$if(title)$ +<header> +<h1 class="title">$title$</h1> +$if(subtitle)$ +<p class="subtitle">$subtitle$</p> +$endif$ +$for(author)$ +<p class="author">$author$</p> +$endfor$ +$if(date)$ +<p class="date">$date$</p> +$endif$ +</header> +$endif$ +$if(return)$ +$return$ +$endif$ +$if(toc)$ +<nav id="$idprefix$TOC"> +$toc$ +</nav> +$endif$ +$body$ +$for(include-after)$ +$include-after$ +$endfor$ +</body> +</html>