From nobody Sun Sep 21 23:21:47 2025 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) client-ip=78.46.105.101; envelope-from=seabios-bounces@seabios.org; helo=coreboot.org; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass(p=reject dis=none) header.from=seabios.org ARC-Seal: i=1; a=rsa-sha256; t=1754523583; cv=none; d=zohomail.com; s=zohoarc; b=epTy9f4K6QZgDeaivy4fQWctY5zOVW9khh5E4+EZG+6ftK7oovL2PjixtWwFtw3jIF+e8AoqZ0vnJSi2geuL/tu3wD4m2OCgKRnn5fCTghEtw7oNuCYDB6A4nZJgquLfKwDnyO0IZp61fgwL3V2LLIoorxjD7dcQIYRP1o/kveo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1754523583; h=Content-Type:Content-Transfer-Encoding:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Owner:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:Reply-To:Reply-To:References:Subject:Subject:To:To:Message-Id:Cc; bh=+SY/D6TTVbfzhmFqHsfmCEPQfLA1X/gTPIKH6EKsls4=; b=mUkjvSUf1YhglnqCblp5BafUpBnUmtYKZYObav4GLZFrS6rUXmXhErCKMxLKyvi4wD3KYR4ssVHtu5vnKnzq5wap7jTkMsLafFOD0gREyuKwRYkTPxBDtENLD6dMHq14JsfTMTtZJ5rZ7FeALMSuZXcqmEVX24x03wiO8twJMos= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of seabios.org designates 78.46.105.101 as permitted sender) smtp.mailfrom=seabios-bounces@seabios.org; dmarc=pass header.from= (p=reject dis=none) Return-Path: Received: from coreboot.org (mail.coreboot.org [78.46.105.101]) by mx.zohomail.com with SMTPS id 1754523583672997.9158452940366; Wed, 6 Aug 2025 16:39:43 -0700 (PDT) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) by coreboot.org (Postfix) with ESMTPA id 83CD740376; Wed, 6 Aug 2025 23:39:41 +0000 (UTC) Received: from authenticated-user (PRIMARY_HOSTNAME [PUBLIC_IP]) [185.70.43.17]) by coreboot.org (Postfix) with ESMTP id D6BB2402D2 for ; Wed, 6 Aug 2025 23:33:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=seabios.org; s=dkim; t=1754523581; h=from:from:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-owner: list-unsubscribe:list-subscribe:list-post; bh=+SY/D6TTVbfzhmFqHsfmCEPQfLA1X/gTPIKH6EKsls4=; b=IMadpDcCcYt/pU+kzCt4R1xayiR1WRloGS9/GokMVzcZsDWQNHEZHeWW462QDrTS9wHsGb +iS9CRizgSPkaSEZcT1ePq7XVUDfV+l5GR/xXKBALzM01ZzcSCSqhNafPzi0AnxZTasKHR 2VmDGHfWDkp6qsg8HieNPQQ9OtmoOs4= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=koconnor.net; s=protonmail2; t=1754523220; x=1754782420; bh=bG2TjS3E6syYanCfX1sl787P4ZhP6pLNVvV9VcxGBGQ=; h=Date:To:From:Subject:Message-ID:In-Reply-To:References: Feedback-ID:From:To:Cc:Date:Subject:Reply-To:Feedback-ID: Message-ID:BIMI-Selector; b=a2WKrEYjwurl5Wxh+Lo0rXo3Zs+Mbktsw5+BqJcuvxtw9O1mTxOcecN2eNISu8SaA xY009Xk/pQzW946snKA2tyvLjJ51NO60PHct2CQafxR4mvtRFTn7XadFSG/K/VUFp3 hNWGm7dcCaOpFpjobWGT4VUr16rjrKVcg222uw/jPWdDlW3sjLs8c/LEktuoL6YKKM RzJ9V4jKqs2NNK69kXTZfbfulfVknUhvnDtFgOL/7uN395dFC8XrjtUN2yVZkfFi+v WNtk6VC+oY0Ol1MqCKV3EteUlTMGLSeEkw/IhgUKZXFWkOtduoGsN5IFQxcbo3fQC5 7z/aEaJJ2+/7Q== Date: Wed, 06 Aug 2025 23:33:35 +0000 To: seabios@seabios.org Message-ID: <20250806233312.868478-4-kevin@koconnor.net> In-Reply-To: <20250806233312.868478-1-kevin@koconnor.net> References: <20250806233312.868478-1-kevin@koconnor.net> Feedback-ID: 132158305:user:proton X-Pm-Message-ID: 836ea020ef87d73763aa9ed790a7657f0a66a359 MIME-Version: 1.0 Message-ID-Hash: OG7QL6U4Y5VEFMKXBI2IWZEWUFXFXQIJ X-Message-ID-Hash: OG7QL6U4Y5VEFMKXBI2IWZEWUFXFXQIJ X-MailFrom: kevin@koconnor.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; header-match-seabios.seabios.org-0; header-match-seabios.seabios.org-1; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.11b1 Precedence: list Subject: [SeaBIOS] [PATCH 3/3] docs: Add mkdocs build tools for building the seabios.org website List-Id: SeaBIOS mailing list Archived-At: List-Archive: List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: From: Kevin O'Connor via SeaBIOS Reply-To: Kevin O'Connor Content-Transfer-Encoding: quoted-printable Authentication-Results: coreboot.org; auth=pass smtp.auth=mailman@coreboot.org smtp.mailfrom=seabios-bounces@seabios.org X-Spamd-Bar: --- X-ZohoMail-DKIM: pass (identity @seabios.org) X-ZM-MESSAGEID: 1754523585584124100 Content-Type: text/plain; charset="utf-8" Support converting the existing SeaBIOS documentation into a website using the mkdocs tool. Signed-off-by: Kevin O'Connor --- docs/_website/README | 12 ++++++ docs/_website/mkdocs-requirements.txt | 10 +++++ docs/_website/mkdocs.yml | 62 +++++++++++++++++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 docs/_website/README create mode 100644 docs/_website/mkdocs-requirements.txt create mode 100644 docs/_website/mkdocs.yml diff --git a/docs/_website/README b/docs/_website/README new file mode 100644 index 0000000..59c7c70 --- /dev/null +++ b/docs/_website/README @@ -0,0 +1,12 @@ +This directory defines the https://www.seabios.org/ website. + +To test deploy the main site locally one can use commands similar to +the following: + +virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/seabios/docs/= _website/mkdocs-requirements.txt +cd ~/seabios && ~/mkdocs-env/bin/mkdocs serve --config-file ~/seabios/docs= /_website/mkdocs.yml -a 0.0.0.0:8000 + +To build the main html run something similar to: + +virtualenv ~/mkdocs-env && ~/mkdocs-env/bin/pip install -r ~/seabios/docs/= _website/mkdocs-requirements.txt +~/mkdocs-env/bin/mkdocs build -f ~/seabios/docs/_website/mkdocs.yml -d ~/s= eabios-site/ diff --git a/docs/_website/mkdocs-requirements.txt b/docs/_website/mkdocs-r= equirements.txt new file mode 100644 index 0000000..08410b1 --- /dev/null +++ b/docs/_website/mkdocs-requirements.txt @@ -0,0 +1,10 @@ +# Python virtualenv module requirements for mkdocs +jinja2=3D=3D3.1.6 +mkdocs=3D=3D1.2.4 +mkdocs-material=3D=3D8.1.3 +mkdocs-simple-hooks=3D=3D0.1.3 +mkdocs-exclude=3D=3D1.0.2 +mdx-truly-sane-lists=3D=3D1.3 +mdx-breakless-lists=3D=3D1.0.1 +py-gfm=3D=3D2.0.0 +markdown=3D=3D3.7 diff --git a/docs/_website/mkdocs.yml b/docs/_website/mkdocs.yml new file mode 100644 index 0000000..d12806b --- /dev/null +++ b/docs/_website/mkdocs.yml @@ -0,0 +1,62 @@ +# Main configuration file for mkdocs generation of www.seabios.org website + +# Site and directory configuration +site_name: SeaBIOS documentation +repo_url: https://git.seabios.org/ +use_directory_urls: False +docs_dir: '../' + +# Custom markdown dialect settings +markdown_extensions: + - toc: + permalink: True + toc_depth: 6 + - attr_list + - mdx_partial_gfm + - mdx_truly_sane_lists + - mdx_breakless_lists +plugins: + search: + lang: en + +# Website layout configuration (using mkdocs-material theme) +theme: + name: material + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: white + accent: blue + toggle: + icon: material/lightbulb + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: grey + accent: light blue + toggle: + icon: material/lightbulb-outline + name: Switch to light mode + features: + - navigation.top + - search.suggest + - search.highlight + - search.share + language: en + +# Navigation hierarchy +nav: + - Download.md + - Releases.md + - Mailinglist.md + - Developer Documentation: + - Developer_Documentation.md + - Build_overview.md + - Memory_Model.md + - Execution_and_code_flow.md + - Linking_overview.md + - Runtime_config.md + - Debugging.md + - Contributing.md + - Developer_links.md + - SeaVGABIOS.md --=20 2.50.1 _______________________________________________ SeaBIOS mailing list -- seabios@seabios.org To unsubscribe send an email to seabios-leave@seabios.org